[hackers] [ubase] Manpage overhaul || sin
commit 7d47c075ccf3f0eaf0a8bdc77e7d65428be3ed59
Author: sin <sin_AT_2f30.org>
Date: Sat Apr 12 13:38:43 2014 +0100
Manpage overhaul
diff --git a/chvt.1 b/chvt.1
index d3bf63a..cc88047 100644
--- a/chvt.1
+++ b/chvt.1
_AT_@ -1,10 +1,8 @@
-.TH CHVT 1 ubase\-VERSION
+.TH CHVT 1 ubase-VERSION
.SH NAME
-chvt \- change foreground virtual terminal
+ Bchvt R - change foreground virtual terminal
.SH SYNOPSIS
-.B chvt
-.I N
+ Bchvt I N
.SH DESCRIPTION
-.B chvt
-brings /dev/ttyN to the foreground. This has the
+ Bchvt R brings /dev/ttyN to the foreground. This has the
same effect as Ctrl-Alt-FN.
diff --git a/clear.1 b/clear.1
index 85b6ed6..839d02e 100644
--- a/clear.1
+++ b/clear.1
_AT_@ -1,4 +1,3 @@
-.TH CLEAR 1 ubase\-VERSION
-.OS Linux
+.TH CLEAR 1 ubase-VERSION
.SH NAME
-clear \- clear the screen
+ Bclear R - clear the screen
diff --git a/df.1 b/df.1
index 1a220f0..fe67b30 100644
--- a/df.1
+++ b/df.1
_AT_@ -1,24 +1,18 @@
-.TH DF 1 ubase\-VERSION
-.OS Linux
+.TH DF 1 ubase-VERSION
.SH NAME
-df \- show file system usage
+ Bdf R - show file system usage
.SH SYNOPSIS
-.B df
-.RB [ \-ahsi ]
+ Bdf R [ B-ahsi R]
.SH DESCRIPTION
-df displays the amount of disk space available on a file system.
+ Bdf R displays the amount of disk space available on a file system.
If no arguments are given, df shows all the file systems using 512-byte
blocks.
.SH OPTIONS
.TP
-.BI \-a
-Show all file systems including dummy ones.
+ B-a R Show all file systems including dummy ones.
.TP
-.BI \-h
-Not implemented.
+ B-h R Not implemented.
.TP
-.BI \-s
-Not implemented.
+ B-s R Not implemented.
.TP
-.BI \-i
-Not implemented.
+ B-i R Not implemented.
diff --git a/eject.1 b/eject.1
index 825a64c..29c88ac 100644
--- a/eject.1
+++ b/eject.1
_AT_@ -1,14 +1,11 @@
-.TH EJECT 1 ubase\-VERSION
-.OS Linux
+.TH EJECT 1 ubase-VERSION
.SH NAME
-eject \- eject removable media
+ Beject R - eject removable media
.SH SYNOPSIS
-.B eject
-.RB [ \-t ]
+ Beject R [ B-t R]
.SH DESCRIPTION
-eject allows the CD-ROM tray to be opened or closed under software
+ Beject R allows the CD-ROM tray to be opened or closed under software
control. If no arguments are given, the CD-ROM tray is opened.
.SH OPTIONS
.TP
-.BI \-t
-If supported, close the CD-ROM tray.
+ B-t R If supported, close the CD-ROM tray.
diff --git a/halt.8 b/halt.8
index 5389d2b..1168d93 100644
--- a/halt.8
+++ b/halt.8
_AT_@ -1,16 +1,14 @@
-.TH HALT 8 ubase\-VERSION
-.OS Linux
+.TH HALT 8 ubase-VERSION
.SH NAME
-halt \- Halt, power-off or reboot the machine
+ Bhalt R - Halt, power-off or reboot the machine
.SH SYNOPSIS
-.B halt
-.RB [ \-pr ]
+ Bhalt R [ B-pr R]
.SH DESCRIPTION
-halt can be used to halt, power-off or reboot the machine.
+ Bhalt R can be used to power-off or reboot the machine.
+This is a low-level tool and should not be used directly or data-loss
+can happen if the filesystems are not properly unmounted first.
.SH OPTIONS
.TP
-.BI \-p
-power-off the machine.
+ B-p R power-off the machine.
.TP
-.BI \-r
-reboot the machine.
+ B-r R reboot the machine.
diff --git a/id.1 b/id.1
index 797f592..6d27cd9 100644
--- a/id.1
+++ b/id.1
_AT_@ -1,18 +1,14 @@
-.TH ID 1 ubase\-VERSION
+.TH ID 1 ubase-VERSION
.SH NAME
-id \- print real and effective user and group IDs
+ Bid R - print real and effective user and group IDs
.SH SYNOPSIS
-.B id
-.RB [ -G ]
-.RB [ user | uid ]
+ Bid R [ B-G R] R[ Iuser R| Iuid R]
.SH DESCRIPTION
-Print user and group information of the calling process to standard output.
+ Bid R prints user and group information of the calling process to standard output.
If a login name or uid is specified, the user and group information of that
user is displayed.
.SH OPTIONS
.TP
-.B \-G
-Display group information as whitespace separated numbers, in no particular
-order.
+ B-G R Display group information as whitespace separated numbers, in no particular order.
.SH SEE ALSO
-.IR who(1)
+who(1)
diff --git a/lsmod.8 b/lsmod.8
index e60c1d0..23a4833 100644
--- a/lsmod.8
+++ b/lsmod.8
_AT_@ -1,7 +1,6 @@
-.TH lsmod 8 ubase\-VERSION
-.OS Linux
+.TH lsmod 8 ubase-VERSION
.SH NAME
-lsmod \- list loaded kernel modules
+ Blsmod R - list loaded kernel modules
.SH DESCRIPTION
-lsmod parses `/proc/modules' and shows the loadable kernel modules that are
+ Blsmod R parses `/proc/modules' and shows the loadable kernel modules that are
currently loaded.
diff --git a/lsusb.8 b/lsusb.8
index 28a62cb..b1f922c 100644
--- a/lsusb.8
+++ b/lsusb.8
_AT_@ -1,7 +1,6 @@
-.TH LSUSB 8 ubase\-VERSION
-.OS Linux
+.TH LSUSB 8 ubase-VERSION
.SH NAME
-lsusb \- list USB devices
+ Blsusb R - list USB devices
.SH DESCRIPTION
-lsusb searches in `/sys/bus/usb/devices' for usb buses and connected devices and prints
+ Blsusb R searches in `/sys/bus/usb/devices' for usb buses and connected devices and prints
them one by one.
diff --git a/mknod.1 b/mknod.1
index 126c9da..0e54284 100644
--- a/mknod.1
+++ b/mknod.1
_AT_@ -1,40 +1,23 @@
-.TH MKNOD 1 ubase\-VERSION
+.TH MKNOD 1 ubase-VERSION
.SH NAME
-mknod \- create a special device file
-
+ Bmknod R - create a special device file
.SH SYNOPSIS
-.B mknod
-.RB [ \-m
-.IR mode ]
-.I name
-.I type
-.I major
-.I minor
-
+ Bmknod R [ B-m Imode R] Iname type major minor
.SH DESCRIPTION
-.B mknod
-Creates a special device file named
-.I name
-with major number
-.IR major ,
-and minor number
-.IR minor .
-
-.IR type
-specifies what kind of special file will be created,
+ Bmknod R reates a special device file named Iname R
+with major number Imajor R, and minor number Iminor R.
+ Itype R specifies what kind of special file will be created
and must be one of:
.TP
-.BR u \ or\ c
+ Bu R or Bc R
A character device.
.TP
-.BR b
+ Bb R
A block device.
-
.SH OPTIONS
.TP
-.B \-m "mode"
+ B-m R Imode R
Set the mode of the new file based on the octal value of
-.IR mode .
-
+ Imode R.
.SH SEE ALSO
-.IR mknod (2)
+mknod (2)
diff --git a/stat.1 b/stat.1
index 7e79ecf..ee693b5 100644
--- a/stat.1
+++ b/stat.1
_AT_@ -1,17 +1,13 @@
-.TH STAT 1 ubase\-VERSION
+.TH STAT 1 ubase-VERSION
.SH NAME
-stat \- display file status
+ Bstat R - display file status
.SH SYNOPSIS
-.B stat
-.RB [ \-L ]
-.RI [ file ...]
+ Bstat R [ B-L R] [ Ifile... R]
.SH DESCRIPTION
-.B stat
-displays information about the given files or stdin if no files
+ Bstat R displays information about the given files or stdin if no files
are specified.
.SH OPTIONS
.TP
-.B \-L
-follow links
+ B-L R follow links
.SH SEE ALSO
-.IR stat (2)
+stat (2)
diff --git a/who.1 b/who.1
index 9773d96..99037a2 100644
--- a/who.1
+++ b/who.1
_AT_@ -1,27 +1,18 @@
-.TH WHO 1 ubase\-VERSION
+.TH WHO 1 ubase-VERSION
.SH NAME
-who \- print who has logged on
+ Bwho R - print who has logged on
.SH SYNOPSIS
-.B who
-.RB [ -m ]
-
+ Bwho R [ B-m R]
.SH DESCRIPTION
-.B who
-prints a list of who has logged on, their controlling tty, and the
+ Bwho R prints a list of who has logged on, their controlling tty, and the
time at which they logged on.
.SH OPTIONS
.TP
-.B \-m
-only show users on current tty
+ B-m R only show users on current tty
.TP
-.B \-l
-also print LOGIN processes
-
+ B-l R also print LOGIN processes
.SH BUGS
-.B who
-relies on the utmp file to be updated responsibly. This
+ Bwho R relies on the utmp file to be updated responsibly. This
doesn't always happen, which can cause who to print completely
bogus data.
-
-.SH SEE ALSO
-.IR utmp (5)
+utmp(5)
Received on Sat Apr 12 2014 - 14:39:41 CEST
This archive was generated by hypermail 2.3.0
: Sat Apr 12 2014 - 14:48:11 CEST