doc: convert man pages to mandoc, fix some typos in the process

master
Hiltjo Posthuma 2015-02-02 18:34:26 +01:00 committed by sin
parent 6253da55c1
commit 544779a7b8
48 changed files with 1161 additions and 754 deletions

22
chvt.1
View File

@ -1,8 +1,14 @@
.TH CHVT 1 ubase-VERSION
.SH NAME
\fBchvt\fR - Change foreground virtual terminal
.SH SYNOPSIS
\fBchvt\fI N
.SH DESCRIPTION
\fBchvt\fR brings /dev/ttyN to the foreground. This has the
same effect as Ctrl-Alt-FN.
.Dd February 2, 2015
.Dt CHVT 1
.Os ubase
.Sh NAME
.Nm chvt
.Nd change foreground virtual terminal
.Sh SYNOPSIS
.Nm
.Ar N
.Sh DESCRIPTION
.Nm
brings
.Pf /dev/tty Ar N
to the foreground. This has the same effect as Ctrl-Alt-FN.

14
clear.1
View File

@ -1,3 +1,11 @@
.TH CLEAR 1 ubase-VERSION
.SH NAME
\fBclear\fR - Clear the screen
.Dd February 2, 2015
.Dt CLEAR 1
.Os ubase
.Sh NAME
.Nm clear
.Nd clear the screen
.Sh SYNOPSIS
.Nm
.Sh DESCRIPTION
.Nm
clears the screen

View File

@ -1,20 +1,31 @@
.TH CTRLALTDEL 8 ubase-VERSION
.SH NAME
\fBctrlaltdel\fR - Set the function of Ctrl-Alt-Del combination
.SH SYNOPSIS
\fBctrlaltdel\fR [\fB-hs\fR]
.SH DESCRIPTION
Based on examination of the linux/kernel/sys.c code, it is clear that
there are two supported functions that the Ctrl-Alt-Del sequence can
perform: a hard reset, which immediately reboots the computer without
calling sync(2) and without any other preparation; and a soft reset,
which sends the SIGINT (interrupt) signal to the init process (this is
always the process with PID 1). If this option is used, the init(8)
.Dd February 2, 2015
.Dt CTRLALTDEL 8
.Os ubase
.Sh NAME
.Nm ctrlaltdel
.Nd set the function of Ctrl-Alt-Del combination
.Sh SYNOPSIS
.Nm
.Op Fl hs
.Sh DESCRIPTION
Based on examination of the
.Pa linux/kernel/sys.c
code, it is clear that there
are two supported functions that the Ctrl-Alt-Del sequence can perform: a
hard reset, which immediately reboots the computer without calling
.Xr sync 2
and without any other preparation; and a soft reset, which sends the
SIGINT (interrupt) signal to the init process (this is always the process
with PID 1). If this option is used, the
.Xr init 8
program must support this feature.
.SH OPTIONS
.TP
\fB-h\fR
Perform a hard reset
.TP
\fB-s\fR
Perform a soft reset
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl h
Perform a hard reset.
.It Fl s
Perform a soft reset.
.El
.Sh SEE ALSO
.Xr sync 2 ,
.Xr init 8

104
dd.1
View File

@ -1,45 +1,63 @@
.TH DD 1 ubase-VERSION
.SH NAME
\fBdd\fR - Copy a file
.SH SYNOPSIS
\fBdd\fR [\fIoperand...\fR]
.SH DESCRIPTION
\fBdd\fR copies the standard input to the standard output. By default input
data is read and written in 64kB blocks. When finished, \fBdd\fR displays the
number of records read and written as well as the total number of bytes copied.
\fBdd\fR syncs the filesystem once it is done copying. If you want
to disable that use the \fInosync\fR option.
.SH OPERANDS
.TP
if=\fIfile\fR
Read input from \fIfile\fR instead of the standard input.
.TP
of=\fIfile\fR
Write output to \fIfile\fR instead of the standard output. If an initial
portion of the output \fIfile\fR is skipped using the seek operand, the output
file is truncated at that point.
.TP
bs[=\fIN\fR]
If bs is not specified, the default blocksize is 64kB. If bs is specified
without setting it to a specific value then an optimal value between the source
and target filesystem will be selected. If this process fails it will fallback
to the system's pagesize. Adjust \fIN\fR to set the block size of the transfers
in bytes.
.TP
seek=\fIN\fR
Seek \fIN\fR blocks from the beginning of the output before copying.
.TP
skip=\fIN\fR
Skip \fIN\fR blocks from the beginning of the input before copying.
.TP
count=\fIN\fR
Copy only \fIN\fR input blocks.
.TP
direct
.Dd February 2, 2015
.Dt DD 1
.Os ubase
.Sh NAME
.Nm dd
.Nd convert and copy a file
.Sh SYNOPSIS
.Nm
.Op Ar operand...
.Sh DESCRIPTION
.Nm
copies the standard input to the standard output. By default input data is
read and written in 64kB blocks. When finished,
.Nm
displays the number of records read and written as well as the total number
of bytes copied.
.Nm
syncs the filesystem once it is done copying. If you want to disable that use
the
.Ar nosync
option.
.Sh OPTIONS
.Bl -tag -width Ds
.It Ar bs Op Ar [=N]
If
.Ar bs
is not specified, the default blocksize is 64kB. If
.Ar bs
is specified
without setting it to a specific value then an optimal value between the
source and target filesystem will be selected. If this process fails it will
fallback to the system's pagesize. Adjust
.Ar N
to set the block size of the transfers in bytes.
.It Ar count=N
Copy only
.Ar N
input blocks.
.It Ar direct
Use direct I/O for data.
.TP
quiet
Enable quiet output.
.TP
nosync
.It Ar if=file
Read input from
.Ar file
instead of the standard input.
.It Ar nosync
Do not sync the filesystem once we are done copying.
.It Ar quiet
Enable quiet output.
.It Ar of=file
Write output to
.Ar file
instead of the standard output. If an initial portion of the output
.Ar file
is skipped using the seek operand, the output file is truncated at that
point.
.It Ar seek=N
Seek
.Ar N
blocks from the beginning of the output before copying.
.It Ar skip=N
Skip
.Ar N blocks from the beginning of the input before copying.
.El

40
df.1
View File

@ -1,23 +1,27 @@
.TH DF 1 ubase-VERSION
.SH NAME
\fBdf\fR - Show file system usage
.SH SYNOPSIS
\fBdf\fR [\fB-ahsi\fR]
.SH DESCRIPTION
\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
\fB-a\fR
.Dd February 2, 2015
.Dt DF 1
.Os ubase
.Sh NAME
.Nm df
.Nd show file system usage
.Sh SYNOPSIS
.Nm
.Op Fl ahis
.Sh DESCRIPTION
.Nm
displays the amount of disk space available on a file system.
If no arguments are given,
.Nm
shows all the file systems using 512-byte blocks.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl a
Show all file systems including dummy ones. This is the default
option.
.TP
\fB-h\fR
.It Fl h
Not implemented.
.TP
\fB-s\fR
.It Fl i
Not implemented.
.TP
\fB-i\fR
.It Fl s
Not implemented.
.El

44
dmesg.1
View File

@ -1,22 +1,28 @@
.TH DMESG 1 ubase-VERSION
.SH NAME
\fBdmesg\fR - Print or control the kernel ring buffer
.SH SYNOPSIS
\fBdmesg\fR [\fB-Ccr\fR] [\fB-n\fR \fIlevel\fR]
.SH DESCRIPTION
\fBdmesg\fR examines or controls the kernel ring buffer. By default
it reads all the messages from the kernel ring buffer and prints them
on stdout.
.SH OPTIONS
.TP
\fB-C\fR
.Dd February 2, 2015
.Dt DMESG 1
.Os ubase
.Sh NAME
.Nm dmesg
.Nd print or control the kernel ring buffer
.Sh SYNOPSIS
.Nm
.Op Fl Ccr
.Op Fl n Ar level
.Sh DESCRIPTION
.Nm
examines or controls the kernel ring buffer. By default it reads all the
messages from the kernel ring buffer and prints them to stdout.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl C
Clear the ring buffer.
.TP
\fB-c\fR
.It Fl c
Clear the ring buffer after printing its contents.
.TP
\fB-n\fR
Set the console \fIlevel\fR.
.TP
\fB-r\fR
.It Fl n Ar level
Set the console
.Ar level .
The log levels are defined in the file
.Pa include/linux/kern_levels.h .
.It Fl r
Print the raw message buffer.
.El

28
eject.1
View File

@ -1,12 +1,18 @@
.TH EJECT 1 ubase-VERSION
.SH NAME
\fBeject\fR - Eject removable media
.SH SYNOPSIS
\fBeject\fR [\fB-t\fR]
.SH DESCRIPTION
\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
\fB-t\fR
.Dd February 2, 2015
.Dt EJECT 1
.Os ubase
.Sh NAME
.Nm eject
.Nd eject removable media
.Sh SYNOPSIS
.Nm
.Op Fl t
.Sh DESCRIPTION
.Nm
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
.Bl -tag -width Ds
.It Fl t
If supported, close the CD-ROM tray.
.El

View File

@ -1,20 +1,27 @@
.TH FALLOCATE 1 ubase-VERSION
.SH NAME
\fBfallocate\fR - Preallocate blocks to a file
.SH SYNOPSIS
\fBfallocate\fR [\fB-o\fI offset\fR] \fB-l\fR \fIlength file\fR
.SH DESCRIPTION
\fBfallocate\fR preallocates blocks to a file. Only certain filesystems
support the fallocate system call. This is a very fast operation to allocate
uninitialized blocks in a file without doing any IO.
As of the Linux kernel v2.6.31, the fallocate system call is supported
by the btrfs, ext4, ocfs2, and xfs filesystems.
.SH OPTIONS
.TP
\fB-o\fR
Specifies the beginning offset of the allocation, in bytes.
.TP
\fB-l\fR
.Dd February 2, 2015
.Dt FALLOCATE 1
.Os ubase
.Sh NAME
.Nm fallocate
.Nd preallocate blocks to a file
.Sh SYNOPSIS
.Nm
.Op Fl o Ar offset
.Fl l Ar length Ar file
.Sh DESCRIPTION
.Nm
preallocates blocks to a file. Only certain filesystems support the
.Xr fallocate 2
system call. This is a very fast operation to allocate uninitialized blocks
in a file without doing any IO. As of the Linux kernel v2.6.31, the
.Xr fallocate 2
system call is supported by the btrfs, ext4, ocfs2, and xfs filesystems.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl l Ar length
Specifies the length of the allocation, in bytes.
.SH SEE ALSO
fallocate(2)
.It Fl o
Specifies the beginning offset of the allocation, in bytes.
.El
.Sh SEE ALSO
.Xr fallocate 2

43
free.1
View File

@ -1,21 +1,24 @@
.TH FREE 1 ubase-VERSION
.SH NAME
\fBfree\fR - Display amount of free and used memory in the system
.SH SYNOPSIS
\fBfree\fR [\fB-bkmg\fR]
.SH DESCRIPTION
\fBfree\fR displays the total amount of free and used physical and swap
memory in the system, as well as the buffers used by the kernel.
.SH OPTIONS
.TP
\fB-b\fR
Display the amount of memory in bytes. This is the default.
.TP
\fB-k\fR
Display the amount of memory in kilobytes.
.TP
\fB-m\fR
Display the amount of memory in megabytes.
.TP
\fB-g\fR
.Dd February 2, 2015
.Dt FREE 1
.Os ubase
.Sh NAME
.Nm free
.Nd display amount of free and used memory in the system
.Sh SYNOPSIS
.Nm
.Op Fl bgkm
.Sh DESCRIPTION
.Nm
displays the total amount of free and used physical and swap memory in the
system, as well as the buffers used by the kernel.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl b
Display the amount of memory in bytes. This is the default.
.It Fl g
Display the amount of memory in gigabytes.
.It Fl k
Display the amount of memory in kilobytes.
.It Fl m
Display the amount of memory in megabytes.
.El

View File

@ -1,8 +1,13 @@
.TH FREERAMDISK 8 ubase-VERSION
.SH NAME
\fBfreeramdisk\fR - Free memory used by the loadlin ramdisk
.SH SYNOPSIS
\fBfreeramdisk\fR
.SH DESCRIPTION
\fBfreeramdisk\fR frees the memory that is used by the ramdisk.
It uses the \fI/dev/ram\fR device node.
.Dd February 2, 2015
.Dt FREERAMDISK 8
.Os ubase
.Sh NAME
.Nm freeramdisk
.Nd free memory used by the loadlin ramdisk
.Sh SYNOPSIS
.Nm
.Sh DESCRIPTION
.Nm
frees the memory that is used by the ramdisk. It uses the
.Pa /dev/ram
device node.

View File

@ -1,24 +1,33 @@
.TH FSFREEZE 8 ubase-VERSION
.SH NAME
\fBfsfreeze\fR - Suspend access to a filesystem
.SH SYNOPSIS
\fBfsfreeze\fR [\fB-f\fR] [\fB-u\fR] \fImountpoint\fR
.SH DESCRIPTION
\fBfsfreeze\fR suspends and resumes access to a filesystem.
\fBfsfreeze\fR is intended to be used with hardware RAID
devices that support the creation of snapshots.
The \fImountpoint\fR argument is the pathname of the directory
where the filesystem is mounted. The filesystem must be mounted
to be frozen.
.SH OPTIONS
.TP
\fB-f\fR
Freeze the filesystem mounted at \fImountpoint\fR.
.TP
\fB-u\fR
Unfreeze the filesystem mounted at \fImountpoint\fR.
.SH BUGS
.TP
.Dd February 2, 2015
.Dt FSFREEZE 8
.Os ubase
.Sh NAME
.Nm fsfreeze
.Nd suspend access to a filesystem
.Sh SYNOPSIS
.Nm
.Op Fl f | Fl u
.Ar mountpoint
.Sh DESCRIPTION
.Nm
suspends and resumes access to a filesystem.
.Nm
is intended to be used with hardware RAID devices that support the creation
of snapshots.
The
.Ar mountpoint
argument is the pathname of the directory where the filesystem is mounted.
The filesystem must be mounted to be frozen.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl f
Freeze the filesystem mounted at
.Ar mountpoint .
.It Fl u
Unfreeze the filesystem mounted at
.Ar mountpoint .
.El
.Sh SEE ALSO
.Xr mount 8
.Sh BUGS
Only works for ext3/4, reiserfs, jfs and xfs.
.SH SEE ALSO
mount(8)

33
getty.8
View File

@ -1,11 +1,22 @@
.TH GETTY 8 ubase-VERSION
.SH NAME
\fBgetty\fR - Suckless linux getty
.SH SYNOPSIS
\fBgetty\fR [\fItty\fR] [\fIterm\fR] [\fIcmd\fR] [\fIargs...\fR]
.SH DESCRIPTION
\fBgetty\fR opens a tty device, prompts for a login name and by default
invokes the /bin/login program. You can start another program instead of
/bin/login via \fIcmd\fR with \fIargs\fR. The hostname is printed in the
login name prompt as well. The \fItty\fR should be specified using an
absolute path.
.Dd February 2, 2015
.Dt GETTY 8
.Os ubase
.Sh NAME
.Nm getty
.Nd suckless linux getty
.Sh SYNOPSIS
.Nm
.Op Ar tty Op Ar term Op Ar cmd Op Ar args...
.Sh DESCRIPTION
.Nm
opens a tty device, prompts for a login name and by default
invokes the /bin/login program. You can start another program instead of
/bin/login via
.Ar cmd
with
.Ar args .
The hostname is printed in the login name prompt as well. The
.Ar tty
should be specified using an absolute path.
.Sh SEE ALSO
.Xr login 1

29
halt.8
View File

@ -1,16 +1,21 @@
.TH HALT 8 ubase-VERSION
.SH NAME
\fBhalt\fR - Power-off or reboot the machine
.SH SYNOPSIS
\fBhalt\fR [\fB-pr\fR]
.SH DESCRIPTION
\fBhalt\fR can be used to power-off or reboot the machine.
.Dd February 2, 2015
.Dt HALT 8
.Os ubase
.Sh NAME
.Nm halt
.Nd power-off or reboot the machine
.Sh SYNOPSIS
.Nm
.Op Fl pr
.Sh DESCRIPTION
.Nm
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
\fB-p\fR
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl p
Power-off the machine.
.TP
\fB-r\fR
.It Fl r
Reboot the machine.
.El

View File

@ -1,25 +1,31 @@
.TH HWCLOCK 8 ubase-VERSION
.SH NAME
\fBhwclock\fR - Query or set the hardware clock
.SH SYNOPSIS
\fBhwclock\fR [\fB-rsw\fR] [\fB-u\fR] [\fIdev\fR]
.SH DESCRIPTION
\fBhwclock\fR is a tool for accessing the hardware clock. You can display
the current time, set the hardware clock from the System Time, or
set the System Time from the hardware clock. It currently only works with UTC.
You can use \fIdev\fR to specify the RTC device node absolute path. By default
it will use \fI/dev/rtc\fR.
.SH FUNCTIONS
.TP
\fB-r\fR
.Dd February 2, 2015
.Dt HWCLOCK 8
.Os ubase
.Sh NAME
.Nm hwclock
.Nd query or set the hardware clock
.Sh SYNOPSIS
.Nm
.Op Fl r | Fl s | Fl w
.Op Fl u
.Op Ar dev
.Sh DESCRIPTION
.Nm
is a tool for accessing the hardware clock. You can display the current time,
set the hardware clock from the System Time, or set the System Time from the
hardware clock. It currently only works with UTC. You can use
.Ar dev
to specify the RTC device node absolute path. By default
it will use
.Pa /dev/rtc .
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl r
Read the hardware clock and print the time on stdout.
.TP
\fB-s\fR
.It Fl s
Set the system time from the hardware clock.
.TP
\fB-w\fR
.It Fl u
Use UTC. This is the default option.
.It Fl w
Set the hardware clock to the system time.
.SH OPTIONS
.TP
\fB-u\fR
Use UTC. This is the default and only option.
.El

39
id.1
View File

@ -1,21 +1,28 @@
.TH ID 1 ubase-VERSION
.SH NAME
\fBid\fR - Print real and effective user and group IDs
.SH SYNOPSIS
\fBid\fR [\fB-g\fR] [\fB-u\fR] [\fB-G\fR] \fR[\fIuser\fR|\fIuid\fR]
.SH DESCRIPTION
\fBid\fR prints user and group information of the calling process to standard output.
.Dd February 2, 2015
.Dt ID 1
.Os ubase
.Sh NAME
.Nm id
.Nd print real and effective user and group IDs
.Sh SYNOPSIS
.Nm
.Op Fl g
.Op Fl u
.Op Fl G
.Op Ar user | uid
.Sh DESCRIPTION
.Nm
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
\fB-g\fR
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl g
Print only the effective group ID.
.TP
\fB-u\fR
.It Fl u
Print only the effective user ID.
.TP
\fB-G\fR
.It Fl G
Display group information as whitespace separated numbers, in no particular order.
.SH SEE ALSO
who(1)
.El
.Sh SEE ALSO
.Xr who 1

View File

@ -1,10 +1,18 @@
.TH INSMOD 8 ubase-VERSION
.SH NAME
\fBinsmod\fR - Insert a module into the Linux kernel
.SH SYNOPSIS
\fBinsmod\fR \fIfilename\fR [\fIargs...\fR]
.SH DESCRIPTION
\fBinsmod\fR inserts the module specified by \fIfilename\fR
into the kernel. It does not handle module dependencies.
.SH SEE ALSO
rmmod(8), lsmod(8)
.Dd February 2, 2015
.Dt INSMOD 8
.Os ubase
.Sh NAME
.Nm insmod
.Nd insert a module into the Linux kernel
.Sh SYNOPSIS
.Nm
.Ar filename
.Op Ar args...
.Sh DESCRIPTION
.Nm
inserts the module specified by
.Ar filename
into the kernel. It does not handle module dependencies.
.Sh SEE ALSO
.Xr lsmod 8 ,
.Xr rmmod 8

View File

@ -1,18 +1,31 @@
.TH KILLALL5 8 ubase-VERSION
.SH NAME
\fBkillall\fR - Send a signal to all processes
.SH SYNOPSIS
\fBkillall5\fR [\fB-o\fI pid1,pid2,...,pidN\fR] [\fB-s\fI signal\fR]
.SH DESCRIPTION
\fBkillall5\fR is an implementation of the SystemV killall command.
It sends a signal to all processes except kernel threads and the processes
in its own session. It is primarily used by the system's init scripts.
.SH OPTIONS
.TP
\fB-o\fR
Tell killall5 to omit processes with that process id.
.TP
\fB-s\fR
Send \fIsignal\fR instead of the default SIGTERM.
.SH SEE ALSO
halt(8), reboot(8)
.Dd February 2, 2015
.Dt KILLALL5 8
.Os ubase
.Sh NAME
.Nm killall5
.Nd send a signal to all processes
.Sh SYNOPSIS
.Nm
.Op Fl o Ar pid1,pid2,...,pidN
.Op Fl s Ar signal
.Sh DESCRIPTION
.Nm
is an implementation of the SystemV
.Xr killall 8
command. It sends a signal to all processes except kernel threads and the
processes in its own session. It is primarily used by the system's init
scripts.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl o
Tell
.Nm
to omit processes with that process id.
.It Fl s Ar signal
Send
.Ar signal
instead of the default SIGTERM.
.El
.Sh SEE ALSO
.Xr halt 8 ,
.Xr reboot 8

View File

@ -1,11 +1,18 @@
.TH LASTLOG 8 ubase-VERSION
.SH NAME
\fBlastlog\fR - Show last login of users
.SH SYPNOSIS
\fBlastlog\fI [user ...]
.SH DESCRIPTION
\fBlastlog\fR Show time, tty, and host (if it was a remote
connection) of last login of users. If some user names are passed
as parameter then information about last login of these users is
shown, otherwise is shown for all the users in /etc/passwd in the
order they appear in it.
.Dd February 2, 2015
.Dt LASTLOG 8
.Os ubase
.Sh NAME
.Nm lastlog
.Nd show last login of users
.Sh SYNOPSIS
.Nm
.Op Ar user...
.Sh DESCRIPTION
.Nm
shows the time, tty and host (if it was a remote connection) of the last
login of the users. If one or more
.Ar user
names are passed as a parameter then information about the last login of these
users are shown, otherwise the users in
.Pa /etc/passwd
will be used and shown in order of appearance.

38
login.1
View File

@ -1,13 +1,27 @@
.TH LOGIN 1 ubase-VERSION
.SH NAME
\fBlogin\fR - Log into the system
.SH SYNOPSIS
\fBlogin\fR [\fB-p\fR] \fIusername\fR
.SH DESCRIPTION
\fBlogin\fR logs the \fIusername\fR into the system. It sets \fBHOME\fR,
\fBSHELL\fR, \fBUSER\fR, \fBLOGNAME\fR and the \fBPATH\fR environment
variables and invokes the login shell as specified in \fI/etc/passwd\fR.
.SH OPTIONS
.TP
\fB-p\fR
.Dd February 2, 2015
.Dt LOGIN 1
.Os ubase
.Sh NAME
.Nm login
.Nd log into the system
.Sh SYNOPSIS
.Nm
.Op Fl p
.Ar username
.Sh DESCRIPTION
.Nm
logs the
.Ar username
into the system. It sets
.Ev HOME ,
.Ev SHELL ,
.Ev USER ,
.Ev LOGNAME
and the
.Ev PATH environment variables and invokes the login shell as specified in
.Pa /etc/passwd .
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl p
Preserve the environment.
.El

19
lsmod.8
View File

@ -1,6 +1,13 @@
.TH lsmod 8 ubase-VERSION
.SH NAME
\fBlsmod\fR - List loaded kernel modules
.SH DESCRIPTION
\fBlsmod\fR parses `/proc/modules' and shows the loadable kernel modules that are
currently loaded.
.Dd February 2, 2015
.Dt LSMOD 8
.Os ubase
.Sh NAME
.Nm lsmod
.Nd list loaded kernel modules
.Sh SYNOPSIS
.Nm
.Sh DESCRIPTION
.Nm
parses
.Pa /proc/modules
and shows the loadable kernel modules that are currently loaded.

19
lsusb.8
View File

@ -1,6 +1,13 @@
.TH LSUSB 8 ubase-VERSION
.SH NAME
\fBlsusb\fR - List USB devices
.SH DESCRIPTION
\fBlsusb\fR searches in `/sys/bus/usb/devices' for usb buses and connected devices and prints
them one by one.
.Dd February 2, 2015
.Dt LSUSB 8
.Os ubase
.Sh NAME
.Nm lsusb
.Nd list USB devices
.Sh SYNOPSIS
.Nm
.Sh DESCRIPTION
.Nm
searches in
.Pa /sys/bus/usb/devices
for USB's and connected devices and prints them one by one.

42
mesg.1
View File

@ -1,19 +1,27 @@
.TH MESG 1 ubase-VERSION
.SH NAME
\fBmesg\fR - Display (do not display) messages from other users
.SH SYNOPSIS
\fBmesg\fR [\fBn\fR|\fBy\fR]
.SH DESCRIPTION
\fBmesg\fR controls write access others have to the terminal device associated
with standard error output. If write access is allowed, then programs such as \fBtalk\fR(1)
and \fBwrite\fR(1) may display messages on the terminal.
.SH OPTIONS
.TP
\fBn\fR
.Dd February 2, 2015
.Dt MESG 1
.Os ubase
.Sh NAME
.Nm mesg
.Nd display (do not display) messages from other users
.Sh SYNOPSIS
.Nm
.Op Fl n | Fl y
.Sh DESCRIPTION
.Nm
controls write access others have to the terminal device associated with
standard error output. If write access is allowed, then programs such as
.Xr talk 1
and
.Xr write 1
may display messages on the terminal.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl n
Disallow messages.
.TP
\fBy\fR
.It Fl y
Allow messages.
.SH SEE ALSO
.TP
write(1)
.El
.Sh SEE ALSO
.Xr talk 1 ,
.Xr write 1

54
mknod.1
View File

@ -1,23 +1,37 @@
.TH MKNOD 1 ubase-VERSION
.SH NAME
\fBmknod\fR - Create a special device file
.SH SYNOPSIS
\fBmknod\fR [\fB-m \fImode\fR] \fIname type major minor
.SH DESCRIPTION
\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
\fBu|c\fR
.Dd February 2, 2015
.Dt MKNOD 1
.Os ubase
.Sh NAME
.Nm mknod
.Nd create a special device file
.Sh SYNOPSIS
.Nm
.Op Fl m Ar mode
.Ar name
.Ar type
.Ar major
.Ar minor
.Sh DESCRIPTION
.Nm
creates a special device file named
.Ar name
with major number
.Ar major ,
and minor number
.Ar minor .
.Ar type
specifies what kind of special file will be created and must be one of:
.Bl -tag -width Ds
.It Ar u | c
A character device.
.TP
\fBb\fR
.It Ar b
A block device.
.SH OPTIONS
.TP
\fB-m\fR
.El
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl m
Set the mode of the new file based on the octal value of
\fImode\fR.
.SH SEE ALSO
mknod (2)
.Ar mode .
.El
.Sh SEE ALSO
.Xr mknod 2

View File

@ -1,12 +1,19 @@
.TH MKSWAP 8 ubase-VERSION
.SH NAME
\fBmkswap\fR - Set up a Linux swap area
.SH SYNOPSIS
\fBmkswap\fR \fIdevice\fR
.SH DESCRIPTION
\fBmkswap\fR sets up a Linux swap area on a device or in a file. The
\fIdevice\fR argument will usually be a disk-partition but it can also be a
file. After creating the swap area you will typically need to use the
\fBswapon\fR command to start using it.
.SH SEE ALSO
swapon(8)
.Dd February 2, 2015
.Dt MKSWAP 8
.Os ubase
.Sh NAME
.Nm mkswap
.Nd set up a Linux swap area
.Sh SYNOPSIS
.Nm
.Ar device
.Sh DESCRIPTION
.Nm
sets up a Linux swap area on a device or in a file. The
.Ar device
argument will usually be a disk-partition but it can also be a file. After
creating the swap area you will typically need to use the
.Xr swapon 8
command to start using it.
.Sh SEE ALSO
.Xr swapon 8

74
mount.8
View File

@ -1,33 +1,45 @@
.TH MOUNT 8 ubase-VERSION
.SH NAME
\fBmount\fR - Mount a filesystem
.SH SYNOPSIS
\fBmount\fR [\fB-BMRan\fR] [\fB-t\fI fstype\fR] [\fB-o\fI options\fR] [\fIsource\fR] [\fItarget\fR]
.SH DESCRIPTION
\fBmount\fR attaches the filesystem specified to the filesystem hierarchy. The \fBumount(8)\fR command will detach it again.
.SH OPTIONS
.TP
\fB-B\fR
Remount a subtree somewhere else (so that its contents are
visible in both places).
.TP
\fB-M\fR
.Dd February 2, 2015
.Dt MOUNT 8
.Os ubase
.Sh NAME
.Nm mount
.Nd mount a filesystem
.Sh SYNOPSIS
.Nm
.Op Fl BMRan
.Op Fl o Ar options
.Op Fl t Ar fstype
.Op Ar source
.Op Ar target
.Sh DESCRIPTION
.Nm
attaches the filesystem specified to the filesystem hierarchy. The
.Xr umount 8
command will detach it again.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl B
Remount a subtree somewhere else (so that its contents are visible in both
places).
.It Fl M
Move a subtree to some other place.
.TP
\fB-R\fR
Remount a subtree and all possible submounts somewhere else (so
that its contents are available in both places).
.TP
\fB-a\fR
Mount all filesystems mentioned in /etc/fstab.
.TP
\fB-n\fR
Mount without writing in /etc/mtab. This is the default action.
.TP
\fB-t\fR
Set the filesystem type.
.TP
\fB-o\fR
.It Fl R
Remount a subtree and all possible submounts somewhere else (so that its
contents are available in both places).
.It Fl a
Mount all filesystems mentioned in
.Pa /etc/fstab .
.It Fl n
Mount without writing in
.Pa /etc/mtab .
This is the default action.
.It Fl o Ar options
Specify a comma separated string of filesystem specific options.
.SH SEE ALSO
mount(2), umount(2), umount(8), swapon(8)
.It Fl t Ar fstype
Set the filesystem type.
.El
.Sh SEE ALSO
.Xr mount 2 ,
.Xr umount 2 ,
.Xr swapon 8 ,
.Xr umount 8

View File

@ -1,22 +1,32 @@
.TH MOUNTPOINT 1 ubase-VERSION
.SH NAME
\fBmountpoint\fR - Check if a directory is a mountpoint
.SH SYNOPSIS
\fBmountpoint\fR [\fB-dq\fR] \fIdirectory\fR
.TP
\fBmountpoint\fR \fB-x\fR \fIdevice\fR
.SH DESCRIPTION
\fBmountpoint\fR checks if the \fIdirectory\fR is mentioned in the
/proc/mounts file.
.SH OPTIONS
.TP
\fB-d\fR
.Dd February 2, 2015
.Dt MOUNTPOINT 1
.Os ubase
.Sh NAME
.Nm mountpoint
.Nd check if a directory is a mountpoint
.Sh SYNOPSIS
.Nm
.Op Fl dq
.Ar directory
.Nm
.Fl x Ar device
.Sh DESCRIPTION
.Nm
checks if the
.Ar directory
is mentioned in the
.Pa /proc/mounts
file.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl d
Print the major/minor device number of the filesystem on stdout.
.TP
\fB-q\fR
.It Fl q
Be quiet, don't print anything.
.TP
\fB-x\fR
Print the major/minor device number of the \fIdevice\fR on stdout.
.SH SEE ALSO
mount(8)
.It Fl x
Print the major/minor device number of the
.Ar device
on stdout.
.El
.Sh SEE ALSO
.Xr mount 8

View File

@ -1,8 +1,12 @@
.TH PAGESIZE 1 ubase-VERSION
.SH NAME
\fBpagesize\fR - Print system page size
.SH SYNOPSIS
\fBpagesize\fR
.SH DESCRIPTION
\fBpagesize\fR prints the size of a page of memory in bytes. This program is
useful in constructing portable shell scripts.
.Dd February 2, 2015
.Dt PAGESIZE 1
.Os ubase
.Sh NAME
.Nm pagesize
.Nd print system page size
.Sh SYNOPSIS
.Nm
.Sh DESCRIPTION
.Nm
prints the size of a page of memory in bytes. This program is
useful in constructing portable shell scripts.

View File

@ -1,11 +1,15 @@
.TH PASSWD 1 ubase-VERSION
.SH NAME
\fBpasswd\fR - Change a user's password
.SH SYNOPSIS
\fBpasswd\fR [\fIusername\fR]
.SH DESCRIPTION
\fBpasswd\fR changes the user's password. The user is prompted
for their current password. If the current password is correctly typed,
a new password is requested. The new password must be entered twice to
avoid typing errors. The superuser is not required to provide a user's
current password.
.Dd February 2, 2015
.Dt PASSWD 1
.Os ubase
.Sh NAME
.Nm passwd
.Nd change a user's password
.Sh SYNOPSIS
.Nm
.Op Ar username
.Sh DESCRIPTION
.Nm
changes the user's password. The user is prompted for their current password.
If the current password is correctly typed, a new password is requested. The
new password must be entered twice to avoid typing errors. The superuser is
not required to provide a user's current password.

37
pidof.1
View File

@ -1,18 +1,25 @@
.TH PIDOF 1 ubase-VERSION
.SH NAME
\fBpidof\fR - Find the process ID of a running program
.SH SYNOPSIS
\fBpidof\fR [\fB-o\fI pid1,pid2,...,pidN\fR] [\fB-s\fR] [\fIprogram...\fR]
.SH DESCRIPTION
\fBpidof\fR finds the process id's of the named programs and prints them on
.Dd February 2, 2015
.Dt PIDOF 1
.Os ubase
.Sh NAME
.Nm pidof
.Nd find the process ID of a running program
.Sh SYNOPSIS
.Nm
.Op Fl o Ar pid1,pid2,...pidN
.Op Fl s
.Op Ar program...
.Sh DESCRIPTION
.Nm
finds the process id's of the named programs and prints them to
stdout.
.SH OPTIONS
.TP
\fB-o\fR
Tell pidof to omit processes with that process id. The special pid
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl o
Tell pidof to omit processes with that process id. The special pid
%PPID can be used to name the parent process of the pidof program.
.TP
\fB-s\fR
.It Fl s
Single shot - this instructs the program to only return one process id.
.SH SEE ALSO
killall5(8)
.El
.Sh SEE ALSO
.Xr killall5 8

View File

@ -1,8 +1,17 @@
.TH PIVOT_ROOT 8 ubase-VERSION
.SH NAME
\fBpivot_root\fR - change the root filesystem
.SH SYNOPSIS
\fBpivot_root\fI new_root put_old\fR
.SH DESCRIPTION
\fBpivot_root\fR moves the root file system of the current process to the
directory \fIput_old\fR and makes \fInew_root\fR the new root file system.
.Dd February 2, 2015
.Dt PIVOT_ROOT 8
.Os ubase
.Sh NAME
.Nm pivot_root
.Nd change the root filesystem
.Sh SYNOPSIS
.Nm
.Ar newroot putold
.Sh DESCRIPTION
.Nm
moves the root file system of the current process to the
directory
.Ar put_old
and makes
.Ar new_root
the new root file system.

41
ps.1
View File

@ -1,26 +1,29 @@
.TH PS 1 ubase-VERSION
.SH NAME
\fBps\fR - Display process status
.SH SYNOPSIS
\fBps\fR [\fB-aAdef\fR]
.SH DESCRIPTION
\fBps\fR displays information about active processes. When given no options,
\fBps\fR prints information about processes of the current user that has a
.Dd February 2, 2015
.Dt PS 1
.Os ubase
.Sh NAME
.Nm ps
.Nd display process status
.Sh SYNOPSIS
.Nm
.Op Fl aAdef
.Sh DESCRIPTION
.Nm
displays information about active processes. When given no options,
.Nm
prints information about processes of the current user that has a
controlling terminal.
.SH OPTIONS
.TP
\fB-a\fR
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl a
Select all processes except both session leaders and processes not
associated with a terminal.
.TP
\fB-A\fR
.It Fl A
Select all processes. Identical to \fB-e\fR.
.TP
\fB-d\fR
.It Fl d
Select all processes except session leaders.
.TP
\fB-e\fR
.It Fl e
Select all processes. Identical to \fB-A\fR.
.TP
\fB-f\fR
.It Fl f
Do full-format listing.
.El

View File

@ -1,11 +1,15 @@
.TH READAHEAD 8 ubase-VERSION
.SH NAME
\fBreadahead\fR - Preload files into disk cache
.SH SYNOPSIS
\fBreadahead\fR \fIfile...\fR
.SH DESCRIPTION
\fBreadahead\fR preloads files into the kernel's disk cache. The
number of pages preloaded depends on the kernel but it is usually around
2MB.
.SH SEE ALSO
readahead(2)
.Dd February 2, 2015
.Dt READAHEAD 8
.Os ubase
.Sh NAME
.Nm preload
.Nd preload files into disk cache
.Sh SYNOPSIS
.Nm
.Ar file...
.Sh DESCRIPTION
.Nm
preloads files into the kernel's disk cache. The number of pages preloaded
depends on the kernel but it is usually around 2MB.
.Sh SEE ALSO
.Xr readahead 2

View File

@ -1,18 +1,32 @@
.TH RESPAWN 1 ubase-VERSION
.SH NAME
\fBrespawn\fR - Spawn the given command repeatedly
.SH SYNOPSIS
\fBrespawn\fR [\fB-l\fI fifo\fR] [\fB-d\fI N\fR] \fIcmd\fR [\fIargs...\fR]
.SH DESCRIPTION
\fBrespawn\fR spawns the given \fIcmd\fR in a new session
repeatedly.
.SH OPTIONS
.TP
\fB-d\fR
.Dd February 2, 2015
.Dt RESPAWN 1
.Os ubase
.Sh NAME
.Nm respawn
.Nd spawn the given command repeatedly
.Sh SYNOPSIS
.Nm
.Op Fl l Ar fifo
.Op Fl d Ar N
.Ar cmd Op Ar args...
.Sh DESCRIPTION
.Nm
spawns the given
.Ar cmd
in a new session repeatedly.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl d
Set the delay between invocations of \fIcmd\fR. It defaults to 0.
.TP
\fB-l\fR
Listen on the specified \fIfifo\fR for writes. For each write
spawn a new instance of \fIcmd\fR. This can be used in conjunction
with a process supervisor to restart a particular program. The \fB-l\fR
and \fB-d\fR options are incompatible. All writes are discarded.
.It Fl l
Listen on the specified
.Ar fifo
for writes. For each write spawn a new instance of
.Ar cmd .
This can be used in conjunction with a process supervisor to restart a
particular program. The
.Fl l
and
.Fl d
options are incompatible. All writes are discarded.
.El

48
rmmod.8
View File

@ -1,23 +1,33 @@
.TH RMMOD 8 ubase-VERSION
.SH NAME
\fBrmmod\fR - Remove a module from the Linux kernel
.SH SYNOPSIS
\fBrmmod\fR [\fB-fw\fR] \fImodule...\fR
.SH DESCRIPTION
\fBrmmod\fR removes one or more modules from the kernel.
.SH OPTIONS
.TP
\fB-f\fR
.Dd February 2, 2015
.Dt RMMOD 8
.Os ubase
.Sh NAME
.Nm rmmod
.Nd remove a module from the Linux kernel
.Sh SYNOPSIS
.Nm
.Op Fl fw
.Ar module...
.Sh DESCRIPTION
.Nm
removes one or more modules from the kernel.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl f
This option can be extremely dangerous: it has no effect unless
CONFIG_MODULE_FORCE_UNLOAD was set when the kernel was compiled.
With this option, you can remove modules which are being used, or
which are not designed to be removed, or have been marked as unsafe.
.TP
\fB-w\fR
Normally, \fBrmmod\fR will refuse to unload modules which are in
use. With this option, \fBrmmod\fR will isolate the module, and
wait until the module is no longer used. Noone new will be
able to use the module, but s up to you to make sure the
current users eventually finish with it.
.SH SEE ALSO
insmod(8), lsmod(8)
.It Fl w
Normally,
.Nm
will refuse to unload modules which are in
use. With this option,
.Nm
will isolate the module, and wait until the module is no longer used. Noone
new will be able to use the module, but it's up to you to make sure the
current users eventually finish with it.
.El
.Sh SEE ALSO
.Xr insmod 8 ,
.Xr lsmod 8

34
stat.1
View File

@ -1,14 +1,24 @@
.TH STAT 1 ubase-VERSION
.SH NAME
\fBstat\fR - Display file status
.SH SYNOPSIS
\fBstat\fR [\fB-L\fR] [\fIfile...\fR]
.SH DESCRIPTION
\fBstat\fR displays information about the given files or stdin if no files
.Dd February 2, 2015
.Dt STAT 1
.Os ubase
.Sh NAME
.Nm stat
.Nd display file status
.Sh SYNOPSIS
.Nm
.Op Fl L
.Op Ar file...
.Sh DESCRIPTION
.Nm
displays information about the given
.Ar files
or stdin if no
.Ar files
are specified.
.SH OPTIONS
.TP
\fB-L\fR
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl L
Follow links.
.SH SEE ALSO
stat (2)
.El
.Sh SEE ALSO
.Xr stat 2

53
su.1
View File

@ -1,20 +1,39 @@
.TH SU 1 ubase-VERSION
.SH NAME
\fBsu\fR - Run a command with a substitute user and group ID
.SH SYNOPSIS
\fBsu\fR [\fB-lp\fR] [\fIusername\fR]
.SH DESCRIPTION
\fBsu\fR allows to run commands with a substitute user and group ID.
When called without arguments, su defaults to running an interactive shell
as root. For backward compatibility su defaults to not change the current
directory and to only set the environment variables \fBHOME\fR and \fBSHELL\fR
(plus \fBUSER\fR and \fBLOGNAME\fR if the target \fIusername\fR is not root).
.SH OPTIONS
.TP
\fB-l\fR
.Dd February 2, 2015
.Dt SU 1
.Os ubase
.Sh NAME
.Nm su
.Nd run a command with a substitute user and group ID
.Sh SYNOPSIS
.Nm
.Op Fl lp
.Op Ar username
.Sh DESCRIPTION
.Nm
allows to run commands with a substitute user and group ID. When called
without arguments,
.Nm
defaults to running an interactive shell as root. For backward compatibility
.Nm
defaults to not change the current directory and to only set the environment
variables
.Ev HOME
and
.Ev SHELL
(plus
.Ev USER
and
.Ev LOGNAME
if the target
.Ar username
is not root).
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl l
Starts the shell as login shell with an environment similar to a real
login.
.TP
\fB-p\fR
Preserves the whole environment. This option is ignored if the \fB-l\fR
.It Fl p
Preserves the whole environment. This option is ignored if the
.Fl l
option is specified.
.El

View File

@ -1,11 +1,18 @@
.TH SWAPLABEL 8 ubase-VERSION
.SH NAME
\fBswaplabel\fR - set the label of a swap filesystem
.SH SYNOPSIS
\fBswaplabel\fR [\fB-L\fI label\fR] \fIdevice\fR
.SH DESCRIPTION
\fBswaplabel\fR is used to change the label of a swap device or file.
.SH OPTIONS
.TP
\fB-L\fR
.Dd February 2, 2015
.Dt SWAPLABEL 8
.Os ubase
.Sh NAME
.Nm swaplabel
.Nd set the label of a swap filesystem
.Sh SYNOPSIS
.Nm
.Op Fl L Ar label
.Ar device
.Sh DESCRIPTION
.Nm
is used to change the label of a swap device or file.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl L Ar label
Change the label.
.El

View File

@ -1,11 +1,17 @@
.TH SWAPOFF 8 ubase-VERSION
.SH NAME
\fBswapoff\fR - disable devices and files for paging and swapping
.SH SYNOPSIS
\fBswapoff\fR [\fB-a\fI device\fR]
.SH DESCRIPTION
\fBswapoff\fR disables swapping on the specified devices and files.
.SH OPTIONS
.TP
\fB-a\fR
.Dd February 2, 2015
.Dt SWAPOFF 8
.Os ubase
.Sh NAME
.Nm swapoff
.Nd disable devices and files for paging and swapping
.Sh SYNOPSIS
.Nm
.Fl a | Ar device
.Sh DESCRIPTION
.Nm
disables swapping on the specified devices and files.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl a
Disable swapping on all known swap devices and files as found in /etc/fstab.
.El