Browse Source

Various man page tweaks and edits

June 2 weeks ago
parent
commit
7965214d28
Signed by: Curtis McEnroe <june@causal.agency> GPG Key ID: CEA2F97ADCFCD77C
4 changed files with 128 additions and 89 deletions
  1. 25
    14
      README
  2. 59
    54
      catgirl.1
  3. 39
    15
      catgirl.7
  4. 5
    6
      sandman.1

+ 25
- 14
README View File

@@ -7,29 +7,40 @@ DESCRIPTION
7 7
      catgirl is a curses IRC client originally intended for use over anonymous
8 8
      SSH.
9 9
 
10
-     It requires LibreSSL and targets FreeBSD, NetBSD and Darwin.
10
+     It requires LibreSSL (-ltls) and targets FreeBSD, Darwin, NetBSD.
11
+
12
+   Build
13
+     On platforms other than FreeBSD, copy the appropriate file to config.mk
14
+     and modify as needed.  The default install PREFIX is ~/.local.
15
+
16
+           cp $(uname).mk config.mk
17
+           make
18
+           make install
11 19
 
12 20
 FILES
13
-     chat.h     Shared state and function prototypes
14
-     chat.c     Command line parsing
15
-     event.c    Event loop and process spawning
16
-     tag.c      Tag (channel, query) ID assignment
17
-     handle.c   Incoming command handling
18
-     input.c    Input command handling
21
+     chat.h     shared state and function prototypes
22
+     chat.c     command line parsing
23
+     event.c    event loop and process spawning
24
+     tag.c      tag (channel, query) ID assignment
25
+     handle.c   incoming command handling
26
+     input.c    input command handling
19 27
      irc.c      TLS client connection
20 28
      format.c   IRC formatting
21
-     ui.c       Curses UI
22
-     term.c     Terminal features unsupported by curses
23
-     edit.c     Line editing
24
-     tab.c      Tab-complete
29
+     ui.c       cursed UI
30
+     term.c     terminal features unsupported by curses
31
+     edit.c     line editing
32
+     tab.c      tab-complete
25 33
      url.c      URL detection
26
-     pls.c      Functions which should not have to be written
27
-     sandman.m  Utility for Darwin to signal sleep
34
+     pls.c      functions which should not have to be written
35
+     sandman.m  utility for Darwin to signal sleep
28 36
 
29
-     sshd_config  Anonymous SSH configuration
37
+     sshd_config  anonymous SSH configuration
30 38
      man.sh       man(1) implementation for chroot
31 39
 
32 40
 SEE ALSO
33 41
      catgirl(1), sandman(1)
34 42
 
43
+BUGS
44
+     The UI is currently broken with NetBSD's curses implementation.
45
+
35 46
 Causal Agency                  December 2, 2018                  Causal Agency

+ 59
- 54
catgirl.1 View File

@@ -1,6 +1,6 @@
1
-.Dd November 27, 2018
1
+.Dd December 2, 2018
2 2
 .Dt CATGIRL 1
3
-.Os "Causal Agency"
3
+.Os
4 4
 .
5 5
 .Sh NAME
6 6
 .Nm catgirl
@@ -20,13 +20,12 @@
20 20
 .
21 21
 .Sh DESCRIPTION
22 22
 .Nm
23
-is a curses IRC client
24
-which only supports TLS.
23
+is a curses, TLS-only IRC client.
25 24
 .
26 25
 .Pp
27 26
 The arguments are as follows:
28 27
 .
29
-.Bl -tag -width Ds
28
+.Bl -tag -width "-w pass"
30 29
 .It Fl N
31 30
 Send notifications with
32 31
 .Xr notify-send 1 .
@@ -90,17 +89,16 @@ are not provided,
90 89
 they will be prompted for.
91 90
 .
92 91
 .Sh COMMANDS
93
-Commands may be entered
94
-as their shortest unique prefix.
92
+Any unique prefix
93
+may be used to abbreviate a command.
95 94
 A slash followed immediately by a number
96 95
 is equivalent to
97 96
 .Ic /view .
98 97
 .
99
-.Bl -tag
98
+.Bl -tag -width Ds
100 99
 .It Ic /close
101 100
 Close the current view.
102
-All views after the current one
103
-are renumbered.
101
+Later views are renumbered.
104 102
 .
105 103
 .It Ic /help
106 104
 Equivalent to
@@ -126,12 +124,10 @@ Equivalent to
126 124
 Change nicknames.
127 125
 .
128 126
 .It Ic /open Op Ar range
129
-Open
127
+.Xr open 1
130 128
 .Ar range
131 129
 most recent URLs
132
-appearing in the current view
133
-with
134
-.Xr open 1 .
130
+appearing in the current view.
135 131
 .Ar range
136 132
 may be a hypen- or comma-separated range
137 133
 from the most recent URL,
@@ -141,12 +137,11 @@ The default
141 137
 is 1.
142 138
 .
143 139
 .It Ic /open Ar substring
144
-Open the most recent URL
140
+.Xr open 1
141
+the most recent URL
145 142
 appearing in the current view
146 143
 matching
147
-.Ar substring
148
-with
149
-.Xr open 1 .
144
+.Ar substring .
150 145
 .
151 146
 .It Ic /part
152 147
 Leave the current channel.
@@ -169,7 +164,7 @@ or set it to
169 164
 .
170 165
 .It Ic /url
171 166
 Hide the UI and
172
-list the most recent URLS
167
+list the most recent URLs
173 168
 which appeared in the current view.
174 169
 Press
175 170
 .Aq Enter
@@ -203,116 +198,126 @@ provides Emacs-like
203 198
 line editing keys,
204 199
 as well as keys for entering
205 200
 IRC formatting codes.
201
+The prefixes
202
+.Sy C- ,
203
+.Sy M-
204
+and
205
+.Sy S-
206
+represent the control, meta and shift modifiers,
207
+respectively.
208
+Special keys are enclosed in
209
+.Aq angle brackets .
206 210
 .
207 211
 .Ss View Keys
208
-.Bl -tag
209
-.It Aq C-l
212
+.Bl -tag -width <PageDown>
213
+.It Sy C-l
210 214
 Redraw the UI.
211 215
 .
212
-.It Aq M-m
216
+.It Sy M-m
213 217
 Insert a blank line in the view.
214 218
 .
215
-.It Ao M-0 Ac ... Ao M-9 Ac
219
+.It Sy M-0 .. Sy M-9
216 220
 Switch to view by number.
217 221
 See
218 222
 .Ic /view .
219 223
 .
220
-.It Aq S-Left
224
+.It Sy S- Ns Aq Sy Left
221 225
 Scroll view up by one line.
222 226
 .
223
-.It Aq S-Right
227
+.It Sy S- Ns Aq Sy Right
224 228
 Scroll view down by one line.
225 229
 .
226
-.It Aq PageUp
230
+.It Aq Sy PageUp
227 231
 Scroll view up by half a page.
228 232
 .
229
-.It Aq PageDown
233
+.It Aq Sy PageDown
230 234
 Scroll view down by half a page.
231 235
 .El
232 236
 .
233 237
 .Ss Line Editing
234
-.Bl -tag
235
-.It Ao C-b Ac Ao Left Ac
238
+.Bl -tag -width "C-f, <Right>"
239
+.It Sy C-b , Aq Sy Left
236 240
 Move cursor left.
237 241
 .
238
-.It Ao C-f Ac Ao Right Ac
242
+.It Sy C-f , Aq Sy Right
239 243
 Move cursor right.
240 244
 .
241
-.It Ao C-a Ac Ao Home Ac
245
+.It Sy C-a , Aq Sy Home
242 246
 Move cursor to beginning of line.
243 247
 .
244
-.It Ao C-e Ac Ao End Ac
248
+.It Sy C-e , Aq Sy End
245 249
 Move cursor to end of line.
246 250
 .
247
-.It Aq M-b
251
+.It Sy M-b
248 252
 Move cursor to beginning of word.
249 253
 .
250
-.It Aq M-f
254
+.It Sy M-f
251 255
 Move cursor to end of word.
252 256
 .
253
-.It Aq Backspace
257
+.It Aq Sy Backspace
254 258
 Delete character before cursor.
255 259
 .
256
-.It Ao C-d Ac Ao Delete Ac
260
+.It Sy C-d , Aq Sy Delete
257 261
 Delete character under cursor.
258 262
 .
259
-.It Ao C-w Ac Ao M-Backspace Ac
263
+.It Sy C-w , Sy M- Ns Aq Sy Backspace
260 264
 Delete word before cursor.
261 265
 .
262
-.It Aq M-d
266
+.It Sy M-d
263 267
 Delete word after cursor.
264 268
 .
265
-.It Aq C-k
269
+.It Sy C-k
266 270
 Delete line after cursor.
267 271
 .
268
-.It Aq Tab
272
+.It Aq Sy Tab
269 273
 Cycle through completions
270 274
 for commands, nicks and channels.
271 275
 .El
272 276
 .
273 277
 .Ss IRC Formatting
274
-.Bl -tag
275
-.It Aq C-n
278
+.Bl -tag -width Ds
279
+.It Sy C-n
276 280
 Reset formatting.
277 281
 .
278
-.It Aq C-o
282
+.It Sy C-o
279 283
 Toggle bold.
280 284
 Note: this may need to be typed as
281
-.Aq C-v C-o .
285
+.Sy C-v C-o .
282 286
 .
283
-.It Aq C-t
287
+.It Sy C-t
284 288
 Toggle italic.
285 289
 .
286
-.It Aq C-u
290
+.It Sy C-u
287 291
 Toggle underline.
288 292
 .
289
-.It Aq C-v
293
+.It Sy C-v
290 294
 Toggle reverse video.
291 295
 Note: this must usually be typed as
292
-.Aq C-v C-v .
296
+.Sy C-v C-v .
293 297
 .
294
-.It Aq C-r
298
+.It Sy C-r
295 299
 Set or reset color.
296 300
 .El
297 301
 .
298 302
 .Pp
299 303
 To reset color,
300 304
 follow
301
-.Aq C-r
305
+.Sy C-r
302 306
 by a non-digit.
303 307
 To set the foreground color,
304 308
 follow
305
-.Aq C-r
309
+.Sy C-r
306 310
 by one or two digits.
307 311
 To set the foreground and background colors,
308 312
 follow
309
-.Aq C-r
313
+.Sy C-r
310 314
 by one or two digits,
311 315
 a comma,
312 316
 and one or two digits.
313 317
 .
314 318
 .Pp
315 319
 The colors are as follows:
320
+.Pp
316 321
 .Bl -tag -width Ds -compact
317 322
 .It 0
318 323
 white
@@ -349,7 +354,7 @@ light gray
349 354
 .El
350 355
 .
351 356
 .Sh ENVIRONMENT
352
-.Bl -tag
357
+.Bl -tag -width SSH_CLIENT
353 358
 .It Ev SSH_CLIENT
354 359
 If
355 360
 .Fl W
@@ -366,7 +371,7 @@ usually the client IP address.
366 371
 .El
367 372
 .
368 373
 .Sh EXAMPLES
369
-.Dl catgirl -h ascii.town -j '&catgirl'
374
+.Dl catgirl -h ascii.town -j '&town'
370 375
 .
371 376
 .Sh STANDARDS
372 377
 .Rs

+ 39
- 15
catgirl.7 View File

@@ -14,49 +14,68 @@ use over anonymous SSH.
14 14
 .
15 15
 .Pp
16 16
 It requires LibreSSL
17
+.Pq Fl ltls
17 18
 and targets
18 19
 .Fx ,
19
-.Nx
20
-and Darwin.
20
+Darwin,
21
+.Nx .
22
+.
23
+.Ss Build
24
+On platforms other than
25
+.Fx ,
26
+copy the appropriate file to
27
+.Pa config.mk
28
+and modify as needed.
29
+The default install
30
+.Ev PREFIX
31
+is
32
+.Pa ~/.local .
33
+.
34
+.Pp
35
+.Bd -literal -offset indent
36
+cp $(uname).mk config.mk
37
+make
38
+make install
39
+.Ed
21 40
 .
22 41
 .Sh FILES
23 42
 .Bl -tag -width sandman.m -compact
24 43
 .It Pa chat.h
25
-Shared state and function prototypes
44
+shared state and function prototypes
26 45
 .It Pa chat.c
27
-Command line parsing
46
+command line parsing
28 47
 .It Pa event.c
29
-Event loop and process spawning
48
+event loop and process spawning
30 49
 .It Pa tag.c
31
-Tag (channel, query) ID assignment
50
+tag (channel, query) ID assignment
32 51
 .It Pa handle.c
33
-Incoming command handling
52
+incoming command handling
34 53
 .It Pa input.c
35
-Input command handling
54
+input command handling
36 55
 .It Pa irc.c
37 56
 TLS client connection
38 57
 .It Pa format.c
39 58
 IRC formatting
40 59
 .It Pa ui.c
41
-Curses UI
60
+cursed UI
42 61
 .It Pa term.c
43
-Terminal features unsupported by curses
62
+terminal features unsupported by curses
44 63
 .It Pa edit.c
45
-Line editing
64
+line editing
46 65
 .It Pa tab.c
47
-Tab-complete
66
+tab-complete
48 67
 .It Pa url.c
49 68
 URL detection
50 69
 .It Pa pls.c
51
-Functions which should not have to be written
70
+functions which should not have to be written
52 71
 .It Pa sandman.m
53
-Utility for Darwin to signal sleep
72
+utility for Darwin to signal sleep
54 73
 .El
55 74
 .
56 75
 .Pp
57 76
 .Bl -tag -width sshd_config -compact
58 77
 .It Pa sshd_config
59
-Anonymous SSH configuration
78
+anonymous SSH configuration
60 79
 .It Pa man.sh
61 80
 .Xr man 1
62 81
 implementation for chroot
@@ -65,3 +84,8 @@ implementation for chroot
65 84
 .Sh SEE ALSO
66 85
 .Xr catgirl 1 ,
67 86
 .Xr sandman 1
87
+.
88
+.Sh BUGS
89
+The UI is currently broken with
90
+.Nx Ap s
91
+curses implementation.

+ 5
- 6
sandman.1 View File

@@ -1,6 +1,6 @@
1
-.Dd November 30, 2018
1
+.Dd December 2, 2018
2 2
 .Dt SANDMAN 1
3
-.Os "Causal Agency"
3
+.Os
4 4
 .
5 5
 .Sh NAME
6 6
 .Nm sandman
@@ -13,16 +13,15 @@
13 13
 .Sh DESCRIPTION
14 14
 .Nm
15 15
 is a utility for Darwin systems.
16
-.Nm
17
-runs the
16
+It runs the
18 17
 .Ar command
19
-in a child process
18
+as a child process
20 19
 and sends it
21 20
 .Dv SIGTSTP
22 21
 and
23 22
 .Dv SIGCONT
24 23
 signals
25
-when the computer goes to sleep
24
+when the system goes to sleep
26 25
 and wakes from sleep,
27 26
 respectively.
28 27
 .

Loading…
Cancel
Save