Update docs #100
Merged
Update docs #100
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Usually the format '[option1|option2]' means EITHER 'option1' OR 'option2' may be specified, but not both. Since the options '-v', '-V', and '-e' can all be given (and are all optional), the proper format is '[-v] [-V] [-e]'.
xfnw
pushed a commit
to xfnw/kirc
that referenced
this pull request
Jan 20, 2022
* add CTCP ACTION information to man page * add documentation for <message> parameter to commands which support it * fix incorrect flag character for real name option * add verbosity option (-V) to man page * separate flag options in usage information Usually the format '[option1|option2]' means EITHER 'option1' OR 'option2' may be specified, but not both. Since the options '-v', '-V', and '-e' can all be given (and are all optional), the proper format is '[-v] [-V] [-e]'.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I noticed that the option
-uwas specified twice in the man page with different meanings. I went through and updated the documentation to reflect the current behavior of kirc.This includes:
-uto-rin the man page@@<target>command to the man page (for CTCP ACTION messages)<message>parameter to the@<target>and@@<target>commands-V) to the man pageusage()function (see commit message for rationale)