9front - general discussion about 9front
 help / color / mirror / Atom feed
* [9front] Clean up drawterm's man page
@ 2022-11-24 20:13 Josiah Frentsos
  0 siblings, 0 replies; only message in thread
From: Josiah Frentsos @ 2022-11-24 20:13 UTC (permalink / raw)
  To: 9front

diff --git a/cpu.c b/cpu.c
index 9cb2a2fb4a2f..cee558ce653d 100644
--- a/cpu.c
+++ b/cpu.c
@@ -243,13 +243,10 @@ ncpu(char *host, char *cmd)
 void
 usage(void)
 {
-	fprint(2, "usage: %s [-GBO] "
-		"[-h host] [-u user] [-a authserver] [-s secstore] "
-		"[-e 'crypt hash'] [-k keypattern] "
-		"[-p] [-t timeout] "
-		"[-r root] "
-		"[-g geometry] "
-		"[-c cmd ...]\n", argv0);
+	fprint(2, "usage: %s [-BGOp] [-a authserver] [-e 'crypt hash'] "
+		"[-g geometry]\n"
+		"\t\t[-h host] [-k keypattern] [-r root] [-s secstore]\n"
+		"\t\t[-t timeout] [-u user] [-c cmd ...]\n", argv0);
 	exits("usage");
 }
 
diff --git a/drawterm.1 b/drawterm.1
index 17987f3f2dab..50c9704c5b9c 100644
--- a/drawterm.1
+++ b/drawterm.1
@@ -1,188 +1,234 @@
 .TH DRAWTERM 1
-
 .SH NAME
-drawterm  \- connection to cpu, fs, and auth servers
-
+drawterm \- connection to cpu, fs, and auth servers
 .SH SYNOPSIS
 .B drawterm
-[
-.B -GBO
-] [
-.B -h
-.I host
-] [
-.B -u
-.I user
-] [
-.B -a
-.I authserver
-] [
-.B -s
-.I secstore
-] [
-.B -e
-\fR'\fIcrypt hash\fR'
-] [
-.B -k
-.I keypattern
-] [
-.B -p
-] [
-.B -t
-.I timeout
-] [
-.B -r
-.I root
-] [
-.B -g
-.I geometry
-] [
-.B -c
-.I cmd \fR...]
-
+.RB [ -BGOp ]
+.RB [ -a
+.IR authserver ]
+.RB [ -e
+.RI ' "crypt hash" ']
+.RB [ -g
+.IR geometry ]
+.RB [ -h
+.IR host ]
+.RB [ -k
+.IR keypattern ]
+.RB [ -r
+.IR root ]
+.RB [ -s
+.IR secstore ]
+.RB [ -t
+.IR timeout ]
+.RB [ -u
+.IR user ]
+.RB [ -c
+.IR "cmd ..." ]
 .SH DESCRIPTION
 .I Drawterm
-is a client for connecting venerable systems to Plan 9 systems. The standard behavior with no options provided is to begin a graphical session which will prompt for a cpu server, auth server, and password. If $USER is not set, drawterm will prompt for a username as well. 
-
-The goal of drawterm is to provide an abstraction layer from the client operating system to the desired Plan 9 system. Client-side devices that can be represented as filesystems will be and are served from the namespace drawterm operates in. Generally, this means that drawterm behaves like a Plan 9 kernel and will attempt to reconstruct a Plan 9 terminal-like experience from a non-Plan 9 system.
-
+is a client for connecting venerable systems to Plan 9 systems.
+The standard behavior with no options provided is to begin a graphical session
+which will prompt for a cpu server, auth server, and password.
+If
+.B $USER
+is not set,
+.I drawterm
+will prompt for a username as well.
+.PP
+The goal of
+.I drawterm
+is to provide an abstraction layer from the client operating system to the
+desired Plan 9 system.
+Client-side devices that can be represented as filesystems will be and are
+served from the namespace
+.I drawterm
+operates in.
+Generally, this means that
+.I drawterm
+behaves like a Plan 9 kernel and will attempt to reconstruct a Plan 9
+terminal-like experience from a non-Plan 9 system.
 .PP
 The options are:
 .PD
-
 .TP
-.B -G
-Start drawterm in text-only mode (no graphics).
-
+.B -a \fIauthserver
+Connect to
+.I authserver
+for auth.
 .TP
 .B -B
 Disable kbdfs.
-
+.TP
+.B -c \fIcmd ...
+The command to run can be passed with
+.B -c
+.IR "cmd ..." ,
+otherwise an interactive shell is started.
+The user's profile is run before the command with
+.B $service
+set to cpu to allow further customization of the environment (see
+.TP
+.B -e \fR'\fIcrypt hash\fR'
+Specifies the '\fIcrypt hash\fR' for the connection.
+The default is 'rc4_256 sha1'.
+Usage of no encryption can be specified by 'clear' as per
+.IR ssl (3).
+Note that this option is deprecated and only relevant to the outdated
+.IR cpu (1)
+protocol.
+.TP
+.B -G
+Start
+.I drawterm
+in text-only mode (no graphics).
+.TP
+.B -g \fIgeometry
+Set
+.IR drawterm 's
+window position and size.
+.TP
+.B -h \fIhost
+Connect to
+.I host
+for cpu.
+.TP
+.B -k \fIkeypattern
+Use
+.I keypattern
+to select a key to authenticate to the remote side (see
+.IR auth (2)).
 .TP
 .B -O
 Use the old
 .IR cpu (1)
-to connect to the cpu server rather than 
-.IR rcpu (1)\fR.
-
+to connect to the cpu server rather than
+.IR rcpu (1).
 .TP
-.B -h \fIhost
-Connect to \fIhost\fR for cpu.
-
+.B -p
+Protect the connection against connection resets by establishing an
+.IR aan (8)
+tunnel.
 .TP
-.B -u \fIuser
-Remote user id.
-
-.TP
-.B -a \fIauthserver
-Connect to \fIauthserver\fR for auth.
-
+.B -r \fIroot
+Specifies the root directory on the client.
+The default is
+.B /root
+and all further paths are relative thereto.
+.IR rc (1)
+for more information).
 .TP
 .B -s \fIsecstore
 Sets the address of the
 .IR secstore (8)
-server. If the -s option is absent,
+server.
+If the
+.B -s
+option is absent,
 .IR secstore (1)
-will attempt to dial tcp!$auth!secstore (or the otherwise specified auth server).
-
-.TP
-.B -e \fR'\fIcrypt hash\fR'
-Specifies the \fR'\fIcrypt hash\fR'
-for the connection. The default is 'rc4_256 sha1'. Usage of no encryption can be specified by 'clear' as per
-.IR ssl (3)\fR. Note that this option is deprecated and only relevant to the outdated
-.IR cpu (1)
-protocol.
-
-.TP
-.B -k \fIkeypattern
-Use keypattern to select a key to authenticate to the remote side (see 
-.IR auth (2)\fR).
-
-.TP
-.B -p
-Protect the connection against connection resets by establishing
-.IR aan (8)
-tunnel.
-
+will attempt to dial tcp!$auth!secstore (or the otherwise specified auth
+server).
 .TP
 .B -t \fItimeout
 Set the timeout for
 .IR aan (8)
-to a value in 
-.I seconds\fR (default is one day).
-
+to a value in seconds (default is one day).
 .TP
-.B -r \fIroot
-Specifies the root directory on the client. The default is
-.I /root
-and all further paths are relative thereto.
-
-.TP
-.B -c \fIcmd \fR...
-The command to run can be passed with -c cmd ..., otherwise an interactive shell is started. The user's profile is run before the command with $service set to cpu to allow further customization of the environment (see 
-.IR rc (1)
-for more information).
-
-.PP
+.B -u \fIuser
+Remote user id.
 .SH ENVIRONMENT VARIABLES
-.IP USER
-Unless otherwise specified, the user stored in $USER is used for authentication.
-
-.IP PASS
-If $PASS is set, no password will be prompted for in authentication and the contents of $PASS will be used instead.
-
-.IP cpu
-Unless otherwise specified, the address stored in $cpu is used for the
+.TP
+.B USER
+Unless otherwise specified, the user stored in
+.B $USER
+is used for authentication.
+.TP
+.B PASS
+If
+.B $PASS
+is set, no password will be prompted for in authentication and the contents of
+.B $PASS
+will be used instead.
+.TP
+.B cpu
+Unless otherwise specified, the address stored in
+.B $cpu
+is used for the
 .IR rcpu (1)
 connection (if set).
-
-.IP auth
-Unless otherwise specified, the address stored in $auth is used for the 
+.TP
+.B auth
+Unless otherwise specified, the address stored in
+.B $auth
+is used for the
 .IR rcpu (1)
 connection (if set).
-
-.PP
 .SH SERVICES
-A number of services are provided in drawterm. The exact functionality and availability of certain features may be dependent on your platform or architecture: 
-
+A number of services are provided in
+.IR drawterm .
+The exact functionality and availability of certain features may be dependent on
+your platform or architecture:
 .TP
 .B /mnt/term
-A mount of the client machine's root filesystem as well as certain virtual filesystems to present Plan 9 devices and interfaces that are not available on non-Plan 9 systems. On Windows this is a directory containing the available lettered disks (C:, A:, etc.). Additionally, there is always a /mnt/term/root folder which is a copy of the client machine's namespace with no virtual filesystems present as to avoid conflicting names (such as with Linux's /root).
-
+A mount of the client machine's root filesystem as well as certain virtual
+filesystems to present Plan 9 devices and interfaces that are not available on
+non-Plan 9 systems.
+On Windows this is a directory containing the available lettered disks
+.RB ( C: ,
+.BR A: ,
+etc.).
+Additionally, there is always a
+.B /mnt/term/root
+folder which is a copy of the client machine's namespace with no virtual
+filesystems present as to avoid conflicting names (such as with Linux's
+.BR /root ).
+.TP
+.B #A
+An audio device filesystem is served, if possible, as a one-level directory in
+.B /dev
+(see
+.IR audio (3)).
+Note that this device, if unable to be served, will not cause a panic in
+.IR drawterm .
 .TP
 .B #b
-Assuming the -B flag is not set, /dev/kbd will be provided for kbdfs (see
-.IR kbd (3)\fR).
-
-.TP
-.B #i
-Assuming the -G flag is not set, various drawing device files will be provided in /dev (see
-.IR draw (3)\fR).
-
-.TP
-.B #m
-Assuming the -G flag is not set, files for controlling the mouse will provided in /dev (see
-.IR mouse (3)\fR).
-
+Assuming the
+.B -B
+flag is not set,
+.B /dev/kbd
+will be provided for kbdfs (see
+.IR kbd (3)).
 .TP
 .B #c
-A number of console device files giving access to the console screen and miscellaneous information are provided and mounted in /dev (see
-.IR cons (3)\fR).
-
+A number of console device files giving access to the console screen and
+miscellaneous information are provided and mounted in
+.B /dev
+(see
+.IR cons (3)).
 .TP
 .B #I
-The network filesystem is served and bound over /net, providing the interface to Internet Protocol stacks (see
-.IR ip (3)\fR).
-
+The network filesystem is served and bound over
+.BR /net ,
+providing the interface to Internet Protocol stacks (see
+.IR ip (3)).
 .TP
-.B #A
-An audio device filesystem is served, if possible, as a one-level directory in /dev (see
-.IR audio (3)\fR).
-Note that this device, if unable to be served, will not cause a panic in drawterm.
-
-.PP
+.B #i
+Assuming the
+.B -G
+flag is not set, various drawing device files will be provided in
+.B /dev
+(see
+.IR draw (3)).
+.TP
+.B #m
+Assuming the
+.B -G
+flag is not set, files for controlling the mouse will provided in
+.B /dev
+(see
+.IR mouse (3)).
 .SH EXAMPLES
-Make a headless rcpu session connecting to 10.30.167.25 using plan9.postnix.us as the auth server with
+Make a headless rcpu session connecting to 10.30.167.25 using plan9.postnix.us
+as the auth server with
 .IR aan (8)
 enabled:
 .IP
@@ -190,44 +236,42 @@ enabled:
 drawterm -G -h 10.30.167.25 -a plan9.postnix.us -p
 .EE
 .PP
-
-Make a session using cpu rather than rcpu to tenshi.postnix.us; this command is the same for connecting to a Plan 9 4th edition system:
+Make a session using cpu rather than rcpu to tenshi.postnix.us; this command is
+the same for connecting to a Plan 9 4th edition system:
 .IP
 .EX
 drawterm -O -h tenshi.postnix.us
 .EE
-.PP
-
-.PP
 .SH SOURCE
 .B https://git.9front.org/plan9front/drawterm/HEAD/info.html
-
-.PP
-.SH "SEE ALSO"
-.IR rc (1),
-.IR cpu (1),
-.IR rcpu(1),
+.SH SEE ALSO
 .IR con (1),
-.IR import (4),
+.IR cpu (1),
+.IR rc (1),
+.IR rcpu (1),
 .IR exportfs (4),
-.IR tlssrv (8),
-.IR aan (8)
-
-.PP
+.IR import (4),
+.IR aan (8),
+.IR tlssrv (8)
 .SH BUGS
-Drawterm is 
+.I Drawterm
+is
 .I not
 a Plan 9 program.
-
-.PP
 .SH HISTORY
-Drawterm was originally developed by Russ Cox (rsc) for Plan 9 4th edition. This original version is still usable on Plan 9 and its forks which use the p9sk1 and older
+.I Drawterm
+was originally developed by Russ Cox (rsc) for Plan 9 4th edition.
+This original version is still usable on Plan 9 and its forks which use the
+p9sk1 and older
 .IR authsrv (6)
 protocols.
 .B https://swtch.com/drawterm/
-
-The 9front project has forked drawterm to incorporate features from 9front, most importantly dp9ik authentication support (see 
-.IR authsrv (6)\fR)
+.PP
+The 9front project has forked
+.B drawterm
+to incorporate features from 9front, most importantly dp9ik authentication
+support (see
+.IR authsrv (6))
 and the TLS-based
 .IR rcpu (1)
 protocol.

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2022-11-24 20:15 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-11-24 20:13 [9front] Clean up drawterm's man page Josiah Frentsos

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).