Rephrase mute options in help text

[ann0see]

The following help text is not precise enough and needs updating:

  -M, --mutestream      starts the application in muted state
      --mutemyown       mute me in my personal mix (headless only)

I actually have no idea what the "help" text for those two options means... so I could be wrong about what that option does...

Originally posted by @pljones in #2322 (reply in thread)

[ann0see]

Mutestream should refer to "Mute myself" maybe something like "-M Mutes the client input such that no audio gets sent to the server. This is the "Mute Myself" option.

Not that sure for the other one.

--mutemyown mutes own channel in personal mix (headless only)

[pljones]

OK, so:

• --mutestream is the "bypass server" option (which doesn't mute for the client it's set on - just doesn't send the audio to the server for mixing, it mixes it locally, meaning no one else hears you but you do) - i.e. the poorly named "Mute myself" checkbox; and
• --mutemyown is "mute me in my server mix" (which means everyone else hears you but you don't) - equivalent to the "Mute" checkbox in the mixer for my own channel.

I guess that

     --mutemyown       mute me in my personal mix (headless only)

could be

     --mutemyown       mute me in my personal server mix (headless only)

for added clarity

Perhaps

  -M, --mutestream      starts the application in muted state

could be

  -M, --mutestream      starts the application with the option to bypass the server mix enabled ("Mute myself")

(I can't remember if I checked on --mutestream to see if it worked headless - some things rely on the UI to work...)

[gilgongo]

Note to self - updates to this will need to go into the new man page as well.

[ann0see]

@gilgongo can you work on rephrasing these options according to Peter's suggestions: #2335 (comment) ?

[gilgongo]

Probably best not to use the same words in the commands and also in the definitions, particularly if "mute" is usually associated with not hearing the thing you're muting. So would the following be slightly clearer?

-M, --mutestream       Do not send my sound to the server ("Mute myself"). Others will not hear me.

--mutemyown            Cut my sound in my personal server mix (headless only). Others will still hear me.

[ann0see]

Maybe slightly better – however I doubt we can do much against this confusion

[ann0see]

@gilgongo I think the mutestream option would be ok.
mutemyown could be

Cut my own sound in my personal mix (headless only). Others will still hear me.

[pljones]

We don't use "cut" in describing the mixer anywhere else, though.

[ann0see]

I think cut was to avoid the ambiguity between both "mute" options

[pljones]

In that case I think we've a bigger issue. This should go back to looking at how to describe these options wherever they appear, in my opinion.

[ann0see]

Yes. However, the re-phrasing should do exactly that?
Changes would need to be applied to the website too ofc.