dzwdz
/
catboy
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Clean up man page

master
Curtis McEnroe 2019-02-21 22:26:25 -05:00
parent 0a417e28e2
commit 1d6fb01074
No known key found for this signature in database
GPG Key ID: CEA2F97ADCFCD77C
1 changed files with 157 additions and 231 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

388
catgirl.1
View File

@ -1,4 +1,4 @@
.Dd December 2, 2018 .Dd February 21, 2019
.Dt CATGIRL 1 .Dt CATGIRL 1
.Os .Os
. .
@ -34,7 +34,7 @@ Send notifications with
. .
.It Fl W Ar pass .It Fl W Ar pass
Send Send
.Ql WEBIRC .Cm WEBIRC
command with command with
.Ar pass . .Ar pass .
See See
@ -59,9 +59,11 @@ after connecting.
may be a comma-separated list. may be a comma-separated list.
. .
.It Fl l Ar path .It Fl l Ar path
Log messages to subdirectories by target Log messages to
and files by date under subdirectories of
.Ar path . .Ar path
named by channel or nick
in files named by date.
. .
.It Fl n Ar nick .It Fl n Ar nick
Set nickname to Set nickname to
@ -86,8 +88,8 @@ the same as the nickname.
. .
.It Fl v .It Fl v
Show raw IRC protocol in the Show raw IRC protocol in the
.Ql -raw- .Sy -raw-
view. window.
. .
.It Fl w Ar pass .It Fl w Ar pass
Log in with Log in with
@ -96,285 +98,209 @@ Log in with
. .
.Pp .Pp
If If
.Fl h .Fl h Ar host
or or
.Fl n .Fl n Ar nick
are not provided, are not provided,
they will be prompted for. they will be prompted for.
. .
.Sh COMMANDS .Sh COMMANDS
Any unique prefix Any unique prefix
may be used to abbreviate a command. may be used to abbreviate a command.
A slash followed immediately by a number
is equivalent to
.Ic /view .
. .
.Ss Chat Commands
.Bl -tag -width Ds .Bl -tag -width Ds
.It Ic /close
Close the current view.
Later views are renumbered.
.
.It Ic /help
Equivalent to
.Ic /man .
.
.It Ic /join Ar chan .It Ic /join Ar chan
Join a channel. Join a channel.
. .
.It Ic /man .It Ic /me Op Ar action
View this manual. Send an action message.
. .
.It Ic /me Ar action .It Ic /names , /who
Send a CTCP
.Ql ACTION
to the current target.
.
.It Ic /names
List users in the current channel. List users in the current channel.
Equivalent to
.Ic /who .
. .
.It Ic /nick Ar nick .It Ic /nick Ar nick
Change nicknames. Change nicknames.
. .
.It Ic /open Op Ar range .It Ic /part Op Ar message
.Xr open 1
.Ar range
most recent URLs
appearing in the current view.
.Ar range
may be a hypen- or comma-separated range
from the most recent URL,
starting at 1.
The default
.Ar range
is 1.
.
.It Ic /open Ar substring
.Xr open 1
the most recent URL
appearing in the current view
matching
.Ar substring .
.
.It Ic /part
Leave the current channel. Leave the current channel.
. .
.It Ic /query Ar nick .It Ic /query Ar nick
Open a private message view with Open a private message view.
.Ar nick .
. .
.It Ic /quit Op Ar message .It Ic /quit Op Ar message
Quit IRC. Quit IRC.
The default
.Ar message
is
.Dq Goodbye .
. .
.It Ic /raw Op Ar command .It Ic /raw Ar command
Toggle the Send a raw IRC command.
.Ql -raw-
view
and send the raw IRC
.Ar command .
. .
.It Ic /topic Op Ar topic .It Ic /topic Op Ar topic
Show the topic of the current channel Show or set the topic of the current channel.
or set it to
.Ar topic .
.
.It Ic /url
Hide the UI and
list the most recent URLs
which appeared in the current view.
Press
.Aq Enter
to resume the UI.
.
.It Ic /view Ar num
Switch to view number
.Ar num .
.
.It Ic /view Ar name
Switch to view for
.Ar name .
.
.It Ic /who
List users in the current channel.
. .
.It Ic /whois Ar nick .It Ic /whois Ar nick
Query information about a user. Query information about a user.
.El .El
. .
.Pp .Pp
Additionally, Any messages entered in the
messages entered in the .Sy -raw-
.Ql -raw- window will be sent as raw IRC commands.
view .
will be sent as raw IRC commands. .Ss UI Commands
A slash followed immediately by a number
is equivalent to the
.Ic /window
command.
.
.Bl -tag -width Ds
.It Ic /close
Close the current window.
.
.It Ic /help , /man
View this manual.
.
.It Ic /open Op Ar range
Open a
.Ar range
of recent URLs
in the current window with
.Xr open 1 .
URLs are numbered
from the most recent
starting at 1.
The
.Ar range
may be a single number,
or a hyphen- or comma-separated range.
.
.It Ic /open Ar substring
Open the most recent URL
in the current window
matching the
.Ar substring .
.
.It Ic /raw
Toggle the
.Sy -raw-
window.
.
.It Ic /url
Hide the UI
and list the most recent URLs
in the current window.
Press
.Aq Enter
to resume the UI.
.
.It Ic /window Ar number | name
Switch to window by number or name.
.El
. .
.Sh KEY BINDINGS .Sh KEY BINDINGS
.Nm .Nm
provides Emacs-like provides
line editing keys, .Xr emacs 1 Ns -like
as well as keys for entering line editing keys
IRC formatting codes. as well as keys for applying IRC formatting.
The prefixes The prefixes
.Sy C- , .Ic C- , M- , S-
.Sy M- represent the control, meta (alt) and shift modifiers,
and
.Sy S-
represent the control, meta and shift modifiers,
respectively. respectively.
Special keys are enclosed in .Ic M- Ns Ar x
.Aq angle brackets . sequences can also be typed as
. .Ic Esc
.Ss View Keys followed by
.Bl -tag -width <PageDown> .Ar x .
.It Sy C-l
Redraw the UI.
.
.It Sy M-m
Insert a blank line in the view.
.
.It Sy M-0 .. Sy M-9
Switch to view by number.
See
.Ic /view .
.
.It Sy S- Ns Aq Sy Left
Scroll view up by one line.
.
.It Sy S- Ns Aq Sy Right
Scroll view down by one line.
.
.It Aq Sy PageUp
Scroll view up by half a page.
.
.It Aq Sy PageDown
Scroll view down by half a page.
.El
. .
.Ss Line Editing .Ss Line Editing
.Bl -tag -width "C-f, <Right>" .Bl -tag -width Ds -compact
.It Sy C-b , Aq Sy Left .It Ic C-a
Move cursor left.
.
.It Sy C-f , Aq Sy Right
Move cursor right.
.
.It Sy C-a , Aq Sy Home
Move cursor to beginning of line. Move cursor to beginning of line.
. .It Ic C-b
.It Sy C-e , Aq Sy End Move cursor left.
Move cursor to end of line. .It Ic C-d
.
.It Sy M-b
Move cursor to beginning of word.
.
.It Sy M-f
Move cursor to end of word.
.
.It Aq Sy Backspace
Delete character before cursor.
.
.It Sy C-d , Aq Sy Delete
Delete character under cursor. Delete character under cursor.
. .It Ic C-e
.It Sy C-w , Sy M- Ns Aq Sy Backspace Move cursor to end of line.
Delete word before cursor. .It Ic C-f
. Move cursor right.
.It Sy M-d .It Ic C-k
Delete word after cursor.
.
.It Sy C-k
Delete line after cursor. Delete line after cursor.
. .It Ic C-w
.It Aq Sy Tab Delete word before cursor.
Cycle through completions .It Ic M-b
for commands, nicks and channels. Move cursor to beginning of word.
. .It Ic M-d
.It Sy M-? Delete word after cursor.
ROT13-encode line. .It Ic M-f
Move cursor to end of word.
.It Ic Tab
Cycle through completions for
commands, nicks and channels.
.El .El
. .
.Ss IRC Formatting .Ss IRC Formatting
.Bl -tag -width Ds .Bl -tag -width Ds -compact
.It Sy C-n .It Ic C-n
Reset formatting. Reset formatting.
. .It Ic C-o
.It Sy C-o
Toggle bold. Toggle bold.
Note: this may need to be typed as This may need to be typed as
.Sy C-v C-o . .Ic C-v C-o .
. .It Ic C-r
.It Sy C-t
Toggle italic.
.
.It Sy C-u
Toggle underline.
.
.It Sy C-v
Toggle reverse video.
Note: this must usually be typed as
.Sy C-v C-v .
.
.It Sy C-r
Set or reset color. Set or reset color.
.It Ic C-t
Toggle italics.
.It Ic C-u
Toggle underline.
.It Ic C-v
Toggle reverse video.
This must usually be typed as
.Ic C-v C-v .
.El .El
. .
.Pp .Pp
To reset color, To reset color, follow
follow .Ic C-r
.Sy C-r
by a non-digit. by a non-digit.
To set the foreground color, To set colors, follow
follow .Ic C-r
.Sy C-r by one or two digits
by one or two digits. to set the foreground color,
To set the foreground and background colors, optionally followed by a comma
follow and one or two digits
.Sy C-r to set the background color.
by one or two digits,
a comma,
and one or two digits.
. .
.Pp .Pp
The colors are as follows: The color numbers are as follows:
.Pp .Pp
.Bl -tag -width Ds -compact .Bl -column "7" "orange (dark yellow)" "15" "pink (light magenta)"
.It 0 .It 0 Ta white Ta \ 8 Ta yellow
white .It 1 Ta black Ta \ 9 Ta light green
.It 1 .It 2 Ta blue Ta 10 Ta cyan
black .It 3 Ta green Ta 11 Ta light cyan
.It 2 .It 4 Ta red Ta 12 Ta light blue
blue .It 5 Ta brown (dark red) Ta 13 Ta pink (light magenta)
.It 3 .It 6 Ta magenta Ta 14 Ta gray
green .It 7 Ta orange (dark yellow) Ta 15 Ta light gray
.It 4 .El
red .
.It 5 .Ss Window Keys
brown (dark red) .Bl -tag -width "PageDown" -compact
.It 6 .It Ic C-l
magenta Redraw the UI.
.It 7 .It Ic M-m
orange (dark yellow) Insert a blank line in the window.
.It 8 .It Ic M- Ns Ar n
yellow Switch to window by number 0\(en9.
.It 9 .It Ic PageDown
light green Scroll window down by half a page.
.It 10 .It Ic PageUp
cyan Scroll window up by half a page.
.It 11 .It Ic S-Left
light cyan Scroll window up by one line.
.It 12 .It Ic S-Right
light blue Scroll window down by one line.
.It 13
pink (light magenta)
.It 14
gray
.It 15
light gray
.El .El
. .
.Sh ENVIRONMENT .Sh ENVIRONMENT
@ -386,7 +312,7 @@ is passed and
.Ev SSH_CLIENT .Ev SSH_CLIENT
is set, is set,
the the
.Ql WEBIRC .Cm WEBIRC
command is used command is used
to set the hostname to set the hostname
to the first word of to the first word of