suckless/ubase
1
0
Fork 0
mirror of git://git.suckless.org/ubase synced 2024-12-22 06:40:38 +00:00
Code Issues Projects Releases Wiki Activity

Manpage overhaul

Browse Source
This commit is contained in:
sin 2014-04-12 13:38:43 +01:00
parent 1392fce27a
commit 7d47c075cc
11 changed files with 64 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
chvt.1
View File

@ -1,10 +1,8 @@
.TH CHVT 1 ubase\-VERSION
.TH CHVT 1 ubase-VERSION
.SH NAME
chvt \- change foreground virtual terminal
\fBchvt\fR - change foreground virtual terminal
.SH SYNOPSIS
.B chvt
.I N
\fBchvt\fI N
.SH DESCRIPTION
.B chvt
brings /dev/ttyN to the foreground. This has the
\fBchvt\fR brings /dev/ttyN to the foreground. This has the
same effect as Ctrl-Alt-FN.

5
clear.1
View File

@ -1,4 +1,3 @@
.TH CLEAR 1 ubase\-VERSION
.OS Linux
.TH CLEAR 1 ubase-VERSION
.SH NAME
clear \- clear the screen
\fBclear\fR - clear the screen

22
df.1
View File

@ -1,24 +1,18 @@
.TH DF 1 ubase\-VERSION
.OS Linux
.TH DF 1 ubase-VERSION
.SH NAME
df \- show file system usage
\fBdf\fR - show file system usage
.SH SYNOPSIS
.B df
.RB [ \-ahsi ]
\fBdf\fR [\fB-ahsi\fR]
.SH DESCRIPTION
df displays the amount of disk space available on a file system.
\fBdf\fR 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.
\fB-a\fR Show all file systems including dummy ones.
.TP
.BI \-h
Not implemented.
\fB-h\fR Not implemented.
.TP
.BI \-s
Not implemented.
\fB-s\fR Not implemented.
.TP
.BI \-i
Not implemented.
\fB-i\fR Not implemented.

13
eject.1
View File

@ -1,14 +1,11 @@
.TH EJECT 1 ubase\-VERSION
.OS Linux
.TH EJECT 1 ubase-VERSION
.SH NAME
eject \- eject removable media
\fBeject\fR - eject removable media
.SH SYNOPSIS
.B eject
.RB [ \-t ]
\fBeject\fR [\fB-t\fR]
.SH DESCRIPTION
eject allows the CD-ROM tray to be opened or closed under software
\fBeject\fR 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.
\fB-t\fR If supported, close the CD-ROM tray.

18
halt.8
View File

@ -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
\fBhalt\fR - Halt, power-off or reboot the machine
.SH SYNOPSIS
.B halt
.RB [ \-pr ]
\fBhalt\fR [\fB-pr\fR]
.SH DESCRIPTION
halt can be used to halt, power-off or reboot the machine.
\fBhalt\fR 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.
\fB-p\fR power-off the machine.
.TP
.BI \-r
reboot the machine.
\fB-r\fR reboot the machine.

16
id.1
View File

@ -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
\fBid\fR - print real and effective user and group IDs
.SH SYNOPSIS
.B id
.RB [ -G ]
.RB [ user | uid ]
\fBid\fR [\fB-G\fR] \fR[\fIuser\fR|\fIuid\fR]
.SH DESCRIPTION
Print user and group information of the calling process to standard output.
\fBid\fR 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.
\fB-G\fR Display group information as whitespace separated numbers, in no particular order.
.SH SEE ALSO
.IR who(1)
who(1)

7
lsmod.8
View File

@ -1,7 +1,6 @@
.TH lsmod 8 ubase\-VERSION
.OS Linux
.TH lsmod 8 ubase-VERSION
.SH NAME
lsmod \- list loaded kernel modules
\fBlsmod\fR - list loaded kernel modules
.SH DESCRIPTION
lsmod parses `/proc/modules' and shows the loadable kernel modules that are
\fBlsmod\fR parses `/proc/modules' and shows the loadable kernel modules that are
currently loaded.

7
lsusb.8
View File

@ -1,7 +1,6 @@
.TH LSUSB 8 ubase\-VERSION
.OS Linux
.TH LSUSB 8 ubase-VERSION
.SH NAME
lsusb \- list USB devices
\fBlsusb\fR - list USB devices
.SH DESCRIPTION
lsusb searches in `/sys/bus/usb/devices' for usb buses and connected devices and prints
\fBlsusb\fR searches in `/sys/bus/usb/devices' for usb buses and connected devices and prints
them one by one.

39
mknod.1
View File

@ -1,40 +1,23 @@
.TH MKNOD 1 ubase\-VERSION
.TH MKNOD 1 ubase-VERSION
.SH NAME
mknod \- create a special device file
\fBmknod\fR - create a special device file
.SH SYNOPSIS
.B mknod
.RB [ \-m
.IR mode ]
.I name
.I type
.I major
.I minor
\fBmknod\fR [\fB-m \fImode\fR] \fIname 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,
\fBmknod\fR reates a special device file named \fIname\fR
with major number \fImajor\fR, and minor number \fIminor\fR.
\fItype\fR specifies what kind of special file will be created
and must be one of:
.TP
.BR u \ or\ c
\fBu\fR or \fBc\fR
A character device.
.TP
.BR b
\fBb\fR
A block device.
.SH OPTIONS
.TP
.B \-m "mode"
\fB-m\fR \fImode\fR
Set the mode of the new file based on the octal value of
.IR mode .
\fImode\fR.
.SH SEE ALSO
.IR mknod (2)
mknod (2)

16
stat.1
View File

@ -1,17 +1,13 @@
.TH STAT 1 ubase\-VERSION
.TH STAT 1 ubase-VERSION
.SH NAME
stat \- display file status
\fBstat\fR - display file status
.SH SYNOPSIS
.B stat
.RB [ \-L ]
.RI [ file ...]
\fBstat\fR [\fB-L\fR] [\fIfile...\fR]
.SH DESCRIPTION
.B stat
displays information about the given files or stdin if no files
\fBstat\fR displays information about the given files or stdin if no files
are specified.
.SH OPTIONS
.TP
.B \-L
follow links
\fB-L\fR follow links
.SH SEE ALSO
.IR stat (2)
stat (2)

25
who.1
View File

@ -1,27 +1,18 @@
.TH WHO 1 ubase\-VERSION
.TH WHO 1 ubase-VERSION
.SH NAME
who \- print who has logged on
\fBwho\fR - print who has logged on
.SH SYNOPSIS
.B who
.RB [ -m ]
\fBwho\fR [\fB-m\fR]
.SH DESCRIPTION
.B who
prints a list of who has logged on, their controlling tty, and the
\fBwho\fR 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
\fB-m\fR only show users on current tty
.TP
.B \-l
also print LOGIN processes
\fB-l\fR also print LOGIN processes
.SH BUGS
.B who
relies on the utmp file to be updated responsibly. This
\fBwho\fR 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)