Commit Graph

146 Commits (714b4bc76a239a7802715f13104cdcafa1020e7c)

Author SHA1 Message Date
June McEnroe 1f9e3463c3 Document using -S to connect over IPv4 or IPv6 2022-03-13 17:33:16 -04:00
June McEnroe c78b511dfb Update STANDARDS section authors, titles and URLs 2022-03-05 16:09:51 -05:00
June McEnroe f51e7b4d2c Give examples of "general events" 2022-02-23 18:05:10 -05:00
June McEnroe 5b3b798c49 Document the interface 2022-02-22 20:04:42 -05:00
June McEnroe 397b4ce6bd Prompt for empty server or SASL passwords 2022-02-12 13:26:38 -05:00
June McEnroe 8dec54801c Add M-s to (temporarily) reveal spoiler text 2022-02-03 22:10:54 -05:00
June McEnroe ceee69f905 Add C-z s to set spoiler text 2022-02-03 21:50:31 -05:00
June McEnroe adff312570 Refer to long option names, prefix commands with $ 2021-12-11 20:55:42 -05:00
Klemens Nanni f8e3414af0 Add -q/quiet option to raise default message visibility threshold
Silencing all windows with `M-+' (across multiple catgirl instances)
can be cumbersome, so provide an option to hide events, JOIN/PART noise,
etc. by default (each window's threshold will persist across load/save
cycles, i.e. when using the `-s/save' option).

Started out as `-v | visibility = threshold' to set a specific level,
the idea of a simpler toggle comes from june, who also squashed other
bugs (as usual).
2021-07-20 12:03:46 -04:00
Klemens Nanni e365bae8e0 Use /ns in manual example
Follow a79a3fc "Use NS and CS server aliases".
2021-07-15 14:42:33 -04:00
Klemens Nanni 2a87dc22ac /whois takes an optional nick argument 2021-07-13 15:16:22 -04:00
C. McEnroe 60660a780e Reword and clarify parts of the manual
Mostly related to the utilities options.
2021-07-13 15:16:22 -04:00
C. McEnroe 91f00dee0d Condense markup for ignore/highlight format 2021-07-13 15:16:22 -04:00
C. McEnroe cad20da70a Point out precedence of multiple files and flags 2021-07-13 15:16:22 -04:00
C. McEnroe 44457f85c6 Save invited channel for /join 2021-07-02 15:24:11 -04:00
C. McEnroe a5a225c52c Add -m mode option to set user modes 2021-06-18 12:28:09 -04:00
C. McEnroe 0d888b88d0 Match windows by substring in /window
This could just iterate over idNames instead, but using complete
means more recently used windows will match first.
2021-06-17 18:52:47 -04:00
Klemens Nanni 1ccadd7c72 Treat `-T's optional argument as optional
`-T[format]' is not possible with getopt(3) but getopt_long(3) supports
"T::" exactly for that, so make the command line option go in line with
configuration files and documentation.

While here, check `has_arg' explicitly as getopt_long(3) only documents
mnemonic values not numerical ones.
2021-06-14 17:00:15 -04:00
Klemens Nanni 1c7a755e67 Nickname defaults to system's username not IRC username
"username" alone is ambiguous and without jumping to ENVIRONMENT
explaining the use of USER, catgirl's user- and nickname options read
like pointing at each other:

-n nick | nick = nick
        Set nickname to nick.  The default nickname is the user's name.
[...]
-u user | user = user
        Set username to user.  The default username is the same as the
        nickname.

Clarify that `-n' does *not* default to `-u's value.
2021-06-05 16:02:46 -04:00
C. McEnroe f559322224 List windows with /window
Reuse the /window command to preserve /wi abbreviation.
2021-05-28 20:40:25 -04:00
C. McEnroe 98206d27ec Use | for /window | /num command 2021-05-28 15:04:08 -04:00
C. McEnroe fc327db52b Prefix = for options with No in manual
Without, the mandoc HTML output includes the space and equals in
the class="Cm" element and generates a permalink of #hash_= for
example.
2021-05-28 14:35:10 -04:00
Klemens Nanni 37343179a4 Tag config options in manual
E.g. ":t debug" will now jump right to the definition just like ":t v"
already did -- at least with mandoc(1) from OpenBSD.
2021-05-27 20:52:41 -04:00
C. McEnroe 27a93090bb Document channel key parameters 2021-05-27 14:10:34 -04:00
C. McEnroe 6d5bcf72c1 Hash the username in kiosk mode
So that the first part of $SSH_CLIENT can be passed as username.
2021-05-27 11:45:47 -04:00
C. McEnroe 27c967864c Clarify -H hash option 2021-05-25 16:11:45 -04:00
C. McEnroe c501437735 Replace freenode with tilde.chat 2021-05-19 11:00:15 -04:00
C. McEnroe 6207aaf1a8 Ignore messages in reply to previously ignored messages
Using the +draft/reply client tag, which is supported by BitBot.
This hides the bot's replies to ignored users or ignored bot command
messages.

This commit is dedicated to the land of Estonia.
2021-05-04 15:34:27 -04:00
C. McEnroe d7ce4b9bc6 Add C-z keys for directly inserting most color codes
So you don't have to remember those dang numbers whose order makes
no sense!
2021-03-17 16:00:06 -04:00
Klemens Nanni e8be141cc0 Refer to glob(7) not sh(1)
Those patterns are not specific to the shell, many commands support them.
2021-03-13 13:23:24 -05:00
C. McEnroe 69450d9fe0 Add note about arrow and navigation keys
And I think with C-Left and C-Right I can actually say "as expected"
now.
2021-03-13 13:17:41 -05:00
C. McEnroe 34cfcb1f04 Attempt to clarify trust option use
Trust is not certificate pinning and should only be used for
self-signed certificates.
2021-03-08 12:42:43 -05:00
C. McEnroe 6435dfdda5 Disable nick and channel colors with hash bound 0 2021-03-08 10:47:18 -05:00
C. McEnroe 4b26ae23cd Add C-z p to manually toggle paste mode
OpenBSD's xterm doesn't have bracketed paste mode, and it would be
nice to still be able to paste in several lines and collapse them
with M-q, provided one remembers to type C-z p first...
2021-02-15 19:15:38 -05:00
C. McEnroe 7807848bda Add C-z C-v for literal next
A little annoying to make it a "chord" like this, but C-v is already
used for scrolling, following Emacs-style key bindings (in order
to have a way to scroll without using "special" keys like the arrows
and page up/down), and C-z is at least already in the business of
inserting control characters. This makes it possible to manually
enter some things that are otherwise only possible with /exec printf.
2021-02-03 14:52:16 -05:00
C. McEnroe d6ff9e53cf Change default timestamp format to %X
This respects the user's locale settings.
2021-01-27 14:18:20 -05:00
C. McEnroe c118c594e3 Add toggleable display of timestamps 2021-01-27 00:15:46 -05:00
C. McEnroe bee17a8278 Clarify configuration path interpretations 2021-01-26 16:40:16 -05:00
C. McEnroe 1a2a1e59dd Expand the opening paragraph of the manual 2021-01-26 14:54:13 -05:00
C. McEnroe bd210e0f35 Disable notify in restricted mode
catgirl shouldn't try to execute a command if it is misconfigured
with both restrict and notify.
2021-01-25 18:27:07 -05:00
C. McEnroe 61b42713e6 Move mention of pledge(2) and unveil(2) to README
The manual is the wrong place to document platform support.
2021-01-25 13:58:02 -05:00
C. McEnroe 95bb627ffb Separate kiosk mode from restrict mode
Restrict mode will focus on sandboxing, while kiosk will continue
to restrict IRC access through a public kiosk. Kiosk mode without
restrict mode allows execution of man 1 catgirl with /help, assuming
external sandboxing.

The /list and /part commands are also added to the list of disabled
commands in kiosk mode, since they are pointless without access to
/join.
2021-01-23 00:48:15 -05:00
C. McEnroe 6a6456a0dc Document that M-l shows timestamps 2021-01-21 10:36:29 -05:00
C. McEnroe 063f2aaa0c Add -I highlight option and /highlight 2021-01-16 14:15:00 -05:00
C. McEnroe 6160b3f18c Remove join/part/quit ignore example
These can now be hidden with M-+.
2021-01-16 13:36:39 -05:00
C. McEnroe d05872303e Generalize ignore toggling to visibility threshold 2021-01-16 12:58:16 -05:00
C. McEnroe c6cd90c2dd Print chain to stdout with -o 2021-01-10 18:00:41 -05:00
C. McEnroe a437761267 Move -o to a separate SYNOPSIS line 2021-01-10 13:20:50 -05:00
C. McEnroe 7b8bd50063 Exit immediately when using -o 2021-01-10 11:47:48 -05:00
C. McEnroe 7bf96ac8e1 Make SYNOPSIS arguments consistent with option names
Can't keep the 4-letter pattern forever :(
2021-01-09 19:15:57 -05:00