Re: [dev] [st] [PATCH] Convert manual to mdoc

From: Michael Reed <m.reed_AT_mykolab.com>
Date: Thu, 28 May 2015 01:55:20 -0400

On 05/28/15 00:49, Michael Reed wrote:
> Hi,
>
> This was mostly a 1-1 conversion, although mandoc(1) -Tlint and igor(1)
> prompted moving AUTHORS down (among other small things).
> Punctuation was also made more consistent to match sbase.
>
> Regards,
> Michael
>

Apologies, I wasn't aware the attachment would be base64 encoded.
I'll just add the patch below.

Regards,
Michael

---
 st.1 | 260 ++++++++++++++++++++++++++++++++-----------------------------------
 1 file changed, 123 insertions(+), 137 deletions(-)
diff --git a/st.1 b/st.1
index 9548c1a..1d9646a 100644
--- a/st.1
+++ b/st.1
_AT_@ -1,151 +1,137 @@
-.TH ST 1 st\-VERSION
-.SH NAME
-st \- simple terminal
-.SH SYNOPSIS
-.B st
-.RB [ \-a ]
-.RB [ \-c
-.IR class ]
-.RB [ \-f
-.IR font ]
-.RB [ \-g
-.IR geometry ]
-.RB [ \-i ]
-.RB [ \-o
-.IR file ]
-.RB [ \-t 
-.IR title ]
-.RB [ \-l
-.IR line ]
-.RB [ \-w 
-.IR windowid ]
-.RB [ \-v ]
-.RB [ \-e
-.IR command ...]
-.RI [ commands ...]
-.PP
-.B st
-.RB [ \-a ]
-.RB [ \-c
-.IR class ]
-.RB [ \-f
-.IR font ]
-.RB [ \-g
-.IR geometry ]
-.RB [ \-i ]
-.RB [ \-o
-.IR file ]
-.RB [ \-t
-.IR title ]
-.RB [ \-l
-.IR line ]
-.RB [ \-w
-.IR windowid ]
-.RB [ \-v ]
-.RB [ \-l
-.IR line ]
-.RI [ stty_args ...]
-.SH DESCRIPTION
-.B st
+.Dd May 28, 2015
+.Dt ST 1
+.Os st-VERSION
+.Sh NAME
+.Nm st
+.Nd simple terminal
+.Sh SYNOPSIS
+.Nm
+.Op Fl a
+.Op Fl c Ar class
+.Op Fl f Ar font
+.Op Fl g Ar geometry
+.Op Fl i
+.Op Fl o Ar file
+.Op Fl t Ar title
+.Op Fl l Ar line
+.Op Fl w Ar windowid
+.Op Fl v
+.Op Fl e Ar command ...
+.Op Ar command ...
+.Pp
+.Nm
+.Op Fl a
+.Op Fl c Ar class
+.Op Fl f Ar font
+.Op Fl g Ar geometry
+.Op Fl i
+.Op Fl o Ar file
+.Op Fl t Ar title
+.Op Fl l Ar line
+.Op Fl w Ar windowid
+.Op Fl v
+.Op Fl l Ar line
+.Op Ar stty_args ...
+.Sh DESCRIPTION
+.Nm
 is a simple terminal emulator.
-.SH OPTIONS
-.TP
-.B \-a
-disable alternate screens in terminal
-.TP
-.BI \-c " class"
-defines the window class (default $TERM).
-.TP
-.BI \-f " font"
-defines the
-.I font
-to use when st is run.
-.TP
-.BI \-g " geometry"
-defines the X11 geometry string.
-The form is [=][<cols>{xX}<rows>][{+-}<xoffset>{+-}<yoffset>]. See
-.BR XParseGeometry (3)
+.Sh OPTIONS
+.Bl -tag -width Ds
+.It Fl a
+Disable alternate screens in terminal.
+.It Fl c Ar class
+Defines the window class (default
+.Ev $TERM ) .
+.It Fl f Ar font
+Defines the
+.Ar font
+to use when
+.Nm
+is run.
+.It Fl g Ar geometry
+Defines the X11 geometry string.
+The form is [=][<cols>{xX}<rows>][{+-}<xoffset>{+-}<yoffset>].
+See
+.Xr XParseGeometry 3
 for further details.
-.TP
-.B \-i
-will fixate the position given with the -g option.
-.TP
-.BI \-o " iofile"
-writes all the I/O to
-.I iofile.
-This feature is useful when recording st sessions. A value of "-" means
-standard output.
-.TP
-.BI \-t " title"
-defines the window title (default 'st').
-.TP
-.BI \-w " windowid"
-embeds st within the window identified by 
-.I windowid
-.TP
-.BI \-l " line"
-use a tty line instead of a pseudo terminal.
-When this flag is used
-remaining arguments are used as flags for stty.
-.TP
-.B \-v
-prints version information to stderr, then exits.
-.TP
-.BI \-e " program " [ " arguments " "... ]"
-st executes
-.I program
-instead of the shell.  If this is used it
-.B must be the last option
-on the command line, as in xterm / rxvt.
-This option is only intended for compability,
-and all the remaining arguments are used as a command
-even without it.
-.SH SHORTCUTS
-.TP
-.B Ctrl-Print Screen
-Toggle if st should print to the
-.I iofile.
-.TP
-.B Shift-Print Screen
+.It Fl i
+Will fixate the position given with the
+.Fl g
+option.
+.It Fl o Ar iofile
+Writes all the I/O to
+.Ar iofile .
+This feature is useful when recording
+.Nm
+sessions.
+A value of "-" means standard output.
+.It Fl t Ar title
+Defines the window title (default 'st').
+.It Fl w Ar windowid
+Embeds
+.Nm
+within the window identified by
+.Ar windowid .
+.It Fl l Ar line
+Use a tty line instead of a pseudo terminal.
+When this flag is used remaining arguments are used as flags for
+.Xr stty 1 .
+.It Fl v
+Prints version information to standard error, then exits.
+.It Fl e Ar program Op Ar arguments ...
+.Nm
+executes
+.Ar program
+instead of the shell.
+If this is used it
+.Sy must be the last option
+on the command line, as in
+.Xr xterm 1
+and
+.Xr rxvt 1 .
+This option is only intended for compatibility,
+and all the remaining arguments are used as a command even without it.
+.El
+.Sh SHORTCUTS
+.Bl -tag -width Ds
+.It Cm Ctrl-Print Screen
+Toggle if
+.Nm
+should print to the
+.Ar iofile .
+.It Cm Shift-Print Screen
 Print the full screen to the
-.I iofile.
-.TP
-.B Print Screen
+.Ar iofile .
+.It Cm Print Screen
 Print the selection to the
-.I iofile.
-.TP
-.B Alt-Shift-Page Up
+.Ar iofile .
+.It Cm Alt-Shift-Page Up
 Increase font size.
-.TP
-.B Alt-Shift-Page Down
+.It Cm Alt-Shift-Page Down
 Decrease font size.
-.TP
-.B Alt-Shift-Home
+.It Cm Alt-Shift-Home
 Reset to default font size.
-.TP
-.B Shift-Insert
+.It Cm Shift-Insert
 Paste from primary selection (middle mouse button).
-.TP
-.B Alt-Shift-Insert
+.It Cm Alt-Shift-Insert
 Paste from clipboard selection.
-.TP
-.B Alt-Shift-c
+.It Cm Alt-Shift-c
 Copy the selected text to the clipboard selection.
-.TP
-.B Alt-Shift-v
+.It Cm Alt-Shift-v
 Paste from the clipboard selection.
-.SH CUSTOMIZATION
-.B st
+.El
+.Sh CUSTOMIZATION
+.Nm
 can be customized by creating a custom config.h and (re)compiling the source
-code. This keeps it fast, secure and simple.
-.SH AUTHORS
-See the LICENSE file for the authors.
-.SH LICENSE
+code.
+This keeps it fast, secure and simple.
+.Sh LICENSE
 See the LICENSE file for the terms of redistribution.
-.SH SEE ALSO
-.BR tabbed (1),
-.BR utmp (1),
-.BR stty (1)
-.SH BUGS
+.Sh SEE ALSO
+.Xr stty 1 ,
+.Xr tabbed 1 ,
+.Xr utmp 1
+.Sh AUTHORS
+See the LICENSE file for the authors.
+.Sh BUGS
 See the TODO file in the distribution.
-
--
2.4.2
Received on Thu May 28 2015 - 07:55:20 CEST

This archive was generated by hypermail 2.3.0 : Thu May 28 2015 - 08:00:11 CEST