#! /bin/sh /usr/share/dpatch/dpatch-run ## 10_doc_manuals.dpatch by the Debian ALSA psychos ## ## All lines beginning with `## DP:' are a description of the patch. ## DP: Misc patches to manual pages @DPATCH@ diff -urNad --exclude=CVS --exclude=.svn ./man/bootlogd.8 /tmp/dpep-work.VkakEo/trunk/man/bootlogd.8 --- ./man/bootlogd.8 2005-12-02 17:22:58.000000000 +0100 +++ /tmp/dpep-work.VkakEo/trunk/man/bootlogd.8 2006-02-15 17:10:18.000000000 +0100 @@ -11,7 +11,7 @@ .SH DESCRIPTION \fBBootlogd\fP runs in the background and copies all strings sent to the \fI/dev/console\fP device to a logfile. If the logfile is not accessible, -the messages will be buffered in-memory until it is. +the messages will be kept in memory until it is. .SH OPTIONS .IP \fB\-d\fP Do not fork and run in the background. @@ -20,19 +20,21 @@ \fIlogfile~\fP unless \fIlogfile~\fP already exists. .IP \fB\-v\fP Show version. -.IP \fB\-l logfile\fP +.IP "\fB\-l\fP \fIlogfile\fP" Log to this logfile. The default is \fI/var/log/boot\fP. -.IP \fB\-p pidfile\fP +.IP "\fB\-p\fP \fIpidfile\fP" Put process-id in this file. The default is no pidfile. .SH BUGS -Bootlogd works by redirecting the console output from the console -device. It copies that output to the real console device and a -logfile. There is no standard way to find out the real console device -if you have a new-style \fI/dev/console\fP device (major 5, minor 1). -\fBBootlogd\fP tries to parse the kernel command line, looking for -console= lines and deducts the real console device from that. If that -syntax is ever changed by the kernel, or a console-type is used -bootlogd does not know about, bootlogd will not work. +Bootlogd works by redirecting the console output from the console device. +(Consequently \fBbootlogd\fP requires PTY support in the kernel configuration.) +It copies that output to the real console device and to a log file. +There is no standard way of ascertaining the real console device +if you have a new-style \fI/dev/console\fP device (major 5, minor 1) +so \fBbootlogd\fP parses the kernel command line looking for +\fBconsole=...\fP lines and deduces the real console device from that. +If that syntax is ever changed by the kernel, or a console type is used that +\fBbootlogd\fP does not know about then \fBbootlogd\fP will not work. + .SH AUTHOR Miquel van Smoorenburg, miquels@cistron.nl .SH "SEE ALSO" diff -urNad --exclude=CVS --exclude=.svn ./man/halt.8 /tmp/dpep-work.VkakEo/trunk/man/halt.8 --- ./man/halt.8 2005-12-02 17:22:58.000000000 +0100 +++ /tmp/dpep-work.VkakEo/trunk/man/halt.8 2006-02-15 17:10:18.000000000 +0100 @@ -36,7 +36,7 @@ .SH DESCRIPTION \fBHalt\fP notes that the system is being brought down in the file \fI/var/log/wtmp\fP, and then either tells the kernel to halt, reboot or -poweroff the system. +power-off the system. .PP If \fBhalt\fP or \fBreboot\fP is called when the system is \fInot\fP in runlevel \fB0\fP or \fB6\fP, in other words when it's running @@ -61,9 +61,9 @@ .IP \fB\-i\fP Shut down all network interfaces just before halt or reboot. .IP \fB\-h\fP -Put all harddrives on the system in standby mode just before halt or poweroff. +Put all hard drives on the system in stand-by mode just before halt or power-off. .IP \fB\-p\fP -When halting the system, do a poweroff. This is the default when halt is +When halting the system, switch off the power. This is the default when halt is called as \fBpoweroff\fP. .\"}}} .\"{{{ Diagnostics @@ -80,14 +80,14 @@ correctly) \fBshutdown\fP will be called, which might not be what you want. Use the \fB-f\fP flag if you want to do a hard \fBhalt\fP or \fBreboot\fP. .PP -The \fB-h\fP flag puts all harddisks in standby mode just before halt -or poweroff. Right now this is only implemented for IDE drives. A side -effect of putting the drive in standby mode is that the write cache +The \fB-h\fP flag puts all hard disks in standby mode just before halt +or power-off. Right now this is only implemented for IDE drives. A side +effect of putting the drive in stand-by mode is that the write cache on the disk is flushed. This is important for IDE drives, since the -kernel doesn't flush the write-cache itself before poweroff. +kernel doesn't flush the write cache itself before power-off. .PP The \fBhalt\fP program uses /proc/ide/hd* to find all IDE disk devices, -which means that /proc needs to be mounted when \fBhalt\fP or +which means that \fI/proc\fP needs to be mounted when \fBhalt\fP or \fBpoweroff\fP is called or the \fB-h\fP switch will do nothing. .PP .\"}}} diff -urNad --exclude=CVS --exclude=.svn ./man/init.8 /tmp/dpep-work.VkakEo/trunk/man/init.8 --- ./man/init.8 2005-12-02 17:22:58.000000000 +0100 +++ /tmp/dpep-work.VkakEo/trunk/man/init.8 2006-02-15 17:10:18.000000000 +0100 @@ -36,21 +36,34 @@ only a selected group of processes to exist. The processes spawned by \fBinit\fP for each of these runlevels are defined in the \fB/etc/inittab\fP file. \fBInit\fP can be in one of eight runlevels: -\fB0\(en6\fP and \fBS\fP or \fBs\fP. The runlevel is +\fB0\(en6\fP and \fBS\fP (a.k.a. \fBs\fP). The runlevel is changed by having a privileged user run \fBtelinit\fP, which sends appropriate signals to \fBinit\fP, telling it which runlevel to change to. .PP -Runlevels \fB0\fP, \fB1\fP, and \fB6\fP are reserved. Runlevel 0 is used to -halt the system, runlevel 6 is used to reboot the system, and runlevel -1 is used to get the system down into single user mode. Runlevel \fBS\fP -is not really meant to be used directly, but more for the scripts that are -executed when entering runlevel 1. For more information on this, +Runlevels \fBS\fP, \fB0\fP, \fB1\fP, and \fB6\fP are reserved. +Runlevel S is used to initialize the system on boot. +When starting runlevel S (on boot) +or runlevel 1 (switching from a multi-user runlevel) +the system is entering ``single-user mode'', after which the +current runlevel is S. +Runlevel 0 is used to halt the system; +runlevel 6 is used to reboot the system. +.PP +After booting through S the system automatically enters one of +the multi-user runlevels 2 through 5, unless there was some +problem that needs to be fixed by the administrator in +single-user mode. +Normally after entering single-user mode +the administrator performs maintenance and then reboots the system. +.PP +For more information, see the manpages for \fBshutdown\fP(8) and \fBinittab\fP(5). .PP Runlevels 7-9 are also valid, though not really documented. This is because "traditional" Unix variants don't use them. -In case you're curious, runlevels \fIS\fP and \fIs\fP are in fact the same. +.PP +Runlevels \fIS\fP and \fIs\fP are the same. Internally they are aliases for the same runlevel. .\"}}} .PP @@ -62,9 +75,10 @@ entry (or no \fB/etc/inittab\fP at all), a runlevel must be entered at the system console. .PP -Runlevel \fBS\fP or \fBs\fP bring the system to single user mode -and do not require an \fB/etc/inittab\fP file. In single user mode, -\fB/sbin/sulogin\fP is invoked on \fB/dev/console\fP. +Runlevel \fBS\fP or \fBs\fP initialize the system +and do not require an \fB/etc/inittab\fP file. +.PP +In single user mode, \fB/sbin/sulogin\fP is invoked on \fB/dev/console\fP. .PP When entering single user mode, \fBinit\fP initializes the consoles \fBstty\fP settings to sane values. Clocal mode is set. Hardware @@ -254,6 +268,14 @@ for them. If the processes change their group, \fBinit\fP can't kill them and you may end up with two processes reading from one terminal line. +.PP +On a Debian system, entering runlevel 1 causes all processes +to be killed except for kernel threads and the script that does +the killing and other processes in its session. +As a consequence of this, it isn't safe to return from runlevel 1 +to a multi-user runlevel: daemons that were started in runlevel S +and are needed for normal operation are no longer running. +The system should be rebooted. .\"}}} .\"{{{ Diagnostics .SH DIAGNOSTICS diff -urNad --exclude=CVS --exclude=.svn ./man/initscript.5 /tmp/dpep-work.VkakEo/trunk/man/initscript.5 --- ./man/initscript.5 2005-12-02 17:22:58.000000000 +0100 +++ /tmp/dpep-work.VkakEo/trunk/man/initscript.5 2006-02-15 17:10:18.000000000 +0100 @@ -29,9 +29,9 @@ PATH=/bin:/sbin:/usr/bin:/usr/sbin export PATH - # Increase the hard filedescriptor limit for all processes - # to 8192. The soft limit is still 1024, but any unpriviliged - # process can increase it's soft limit up to the hardlimit + # Increase the hard file descriptor limit for all processes + # to 8192. The soft limit is still 1024, but any unprivileged + # process can increase its soft limit up to the hard limit # with "ulimit -Sn xxx" (needs a 2.2.13 or later Linux kernel). ulimit -Hn 8192 diff -urNad --exclude=CVS --exclude=.svn ./man/inittab.5 /tmp/dpep-work.VkakEo/trunk/man/inittab.5 --- ./man/inittab.5 2005-12-02 17:22:58.000000000 +0100 +++ /tmp/dpep-work.VkakEo/trunk/man/inittab.5 2006-02-15 17:10:18.000000000 +0100 @@ -128,7 +128,7 @@ .\"}}} .\"{{{ powerokwait .IP \fBpowerokwait\fP -This process will be executed as soon as \fBinit\fP is informormed that the +This process will be executed as soon as \fBinit\fP is informed that the power has been restored. .\"}}} .\"{{{ powerfailnow diff -urNad --exclude=CVS --exclude=.svn ./man/last.1 /tmp/dpep-work.VkakEo/trunk/man/last.1 --- ./man/last.1 2005-12-02 17:22:58.000000000 +0100 +++ /tmp/dpep-work.VkakEo/trunk/man/last.1 2006-02-15 17:10:18.000000000 +0100 @@ -51,6 +51,8 @@ .\"}}} .\"{{{ Options .SH OPTIONS +.IP "\fB\-f\fP \fIfile\fP" +Tells \fBlast\fP to use a specific file instead of \fB/var/log/wtmp\fP. .IP \fB\-\fP\fInum\fP This is a count telling \fBlast\fP how many lines to show. .IP "\fB\-n\fP \fInum\fP" diff -urNad --exclude=CVS --exclude=.svn ./man/mesg.1 /tmp/dpep-work.VkakEo/trunk/man/mesg.1 --- ./man/mesg.1 2005-12-02 17:22:58.000000000 +0100 +++ /tmp/dpep-work.VkakEo/trunk/man/mesg.1 2006-02-15 17:10:18.000000000 +0100 @@ -26,7 +26,9 @@ .PP If no option is given, \fBmesg\fP prints out the current access state of your terminal. -.PP NOTES +.\"}}} +.\"{{{ Notes +.SH NOTES \fBMesg\fP assumes that its standard input is connected to your terminal. That also means that if you are logged in multiple times, you can get/set the mesg status of other sessions by using redirection. diff -urNad --exclude=CVS --exclude=.svn ./man/pidof.8 /tmp/dpep-work.VkakEo/trunk/man/pidof.8 --- ./man/pidof.8 2005-12-02 17:22:58.000000000 +0100 +++ /tmp/dpep-work.VkakEo/trunk/man/pidof.8 2006-02-15 17:12:34.000000000 +0100 @@ -31,9 +31,16 @@ Tells \fIpidof\fP to omit processes with that process id. The special pid \fB%PPID\fP can be used to name the parent process of the \fIpidof\fP program, in other words the calling shell or shell script. +.SH "EXIT STATUS" +.TP +.B 0 +At least one program was found with the requested name. +.TP +.B 1 +No program was found with the requested name. .SH NOTES -\fIpidof\fP is simply a (symbolic) link to the \fIkillall5\fP program, -which should also be located in \fP/sbin\fP. +\fIpidof\fP is actually the same program as \fIkillall5\fP; +the program behaves according to the name under which it is called. .PP When \fIpidof\fP is invoked with a full pathname to the program it should find the pid of, it is reasonably safe. Otherwise it is possible diff -urNad --exclude=CVS --exclude=.svn ./man/shutdown.8 /tmp/dpep-work.VkakEo/trunk/man/shutdown.8 --- ./man/shutdown.8 2005-12-02 17:22:58.000000000 +0100 +++ /tmp/dpep-work.VkakEo/trunk/man/shutdown.8 2006-02-15 17:10:18.000000000 +0100 @@ -54,7 +54,7 @@ .\"}}} .\"{{{ -h .IP \fB\-h\fP -Halt or poweroff after shutdown. +Halt or power off after shutdown. .\"}}} .\"{{{ -H .IP \fB\-H\fP @@ -100,10 +100,11 @@ Second, it can be in the format \fB+\fP\fIm\fP, in which \fIm\fP is the number of minutes to wait. The word \fBnow\fP is an alias for \fB+0\fP. .PP -If shutdown is called with a delay, it creates the advisory file +If shutdown is called with a delay, it will create the advisory file .I /etc/nologin which causes programs such as \fIlogin(1)\fP to not allow new user -logins. Shutdown removes this file if it is stopped before it +logins. This file is created five minutes before the shutdown sequence +starts. Shutdown removes this file if it is stopped before it can signal init (i.e. it is cancelled or something goes wrong). It also removes it before calling init to change the runlevel. .PP @@ -117,13 +118,13 @@ file \fI/forcefsck\fP which can be tested by the system when it comes up again. The boot rc file can test if this file is present, and decide to run \fBfsck\fP(1) with a special `force' flag so that even properly -unmounted filesystems get checked. +unmounted file systems get checked. After that, the boot process should remove \fI/forcefsck\fP. .PP The \fB-n\fP flag causes \fBshutdown\fP not to call \fBinit\fP, but to kill all running processes itself. \fBshutdown\fP will then turn off quota, accounting, and swapping -and unmount all filesystems. +and unmount all file systems. .\"}}} .\"{{{ Files .SH ACCESS CONTROL diff -urNad --exclude=CVS --exclude=.svn ./man/sulogin.8 /tmp/dpep-work.VkakEo/trunk/man/sulogin.8 --- ./man/sulogin.8 2005-12-02 17:22:58.000000000 +0100 +++ /tmp/dpep-work.VkakEo/trunk/man/sulogin.8 2006-02-15 17:10:18.000000000 +0100 @@ -1,61 +1,68 @@ -.TH SULOGIN 8 "04 Nov 2003" "" "Linux System Administrator's Manual" +.TH SULOGIN 8 "17 Jan 2006" "" "Linux System Administrator's Manual" .SH NAME -sulogin -- Single-user login +sulogin \- Single-user login .SH SYNOPSIS .B sulogin -.RB [ " -e " ] -.RB [ " -p " ] -.RB [ " -t timeout " ] -.RB [ " tty-device " ] +[ \fB\-e\fP ] +[ \fB\-p\fP ] +[ \fB\-t\fP \fISECONDS\fP ] +[ \fITTY\fP ] .SH DESCRIPTION .I sulogin -is invoked by \fBinit(8)\fP when the system goes into single user mode -(this is done through an entry in \fIinittab(5)\fP). \fBInit\fP also -tries to execute \fIsulogin\fP when it is passed the \fB-b\fP flag -from the bootmonitor (eg, LILO). +is invoked by \fBinit(8)\fP when the system goes into single user mode. +(This is done through an entry in \fIinittab(5)\fP.) +\fBInit\fP also +tries to execute \fIsulogin\fP when +the boot loader (e.g., \fBgrub\fP(8)) +passes it the \fB\-b\fP option. .PP The user is prompted .IP "" .5i Give root password for system maintenance .br -(or type Control-D for normal startup): +(or type Control\-D for normal startup): .PP \fIsulogin\fP will be connected to the current terminal, or to the optional device that can be specified on the command line (typically \fB/dev/console\fP). .PP -If the \fB-p\fP flag was set, the single-user shell will be invoked -with a \fIdash\fP as the first character in \fIargv[0]\fP. That will -cause most shells to behave as a login shell. The default is \fInot\fP -to do this, so that the shell will \fInot\fP read \fB/etc/profile\fP +If the \fB\-t\fP option is used then the program only waits +the given number of seconds for user input. +.PP +If the \fB\-p\fP option is used then the single-user shell is invoked +with a \fIdash\fP as the first character in \fIargv[0]\fP. +This causes the shell process to behave as a login shell. +The default is \fInot\fP to do this, +so that the shell will \fInot\fP read \fB/etc/profile\fP or \fB$HOME/.profile\fP at startup. .PP -After the user exits the single-user shell, or presses control-d at the -prompt, the system will (continue to) boot to the default runlevel. +After the user exits the single-user shell, +or presses control\-D at the prompt, +the system will (continue to) boot to the default runlevel. .SH ENVIRONMENT VARIABLES \fIsulogin\fP looks for the environment variable \fBSUSHELL\fP or \fBsushell\fP to determine what shell to start. If the environment variable is not set, it will try to execute root's shell from /etc/passwd. If that fails it will fall back to \fB/bin/sh\fP. .PP -This is very valuable together with the \fB-b\fP flag to init. To boot +This is very valuable together with the \fB\-b\fP option to init. To boot the system into single user mode, with the root file system mounted read/write, -using a special "failsafe" shell that is statically linked (this example +using a special "fail safe" shell that is statically linked (this example is valid for the LILO bootprompt) .PP -boot: linux -b rw sushell=/sbin/sash +boot: linux \-b rw sushell=/sbin/sash .SH FALLBACK METHODS \fIsulogin\fP checks the root password using the standard method (getpwnam) first. -Then, if the \fB-e\fP option was specified, +Then, if the \fB\-e\fP option was specified, \fIsulogin\fP examines these files directly to find the root password: .PP /etc/passwd, .br /etc/shadow (if present) .PP -If they are damaged or non-existant, sulogin will start a root shell -without asking for a password. Only use the \fB-e\fP option if you +If they are damaged or nonexistent, sulogin will start a root shell +without asking for a password. Only use the \fB\-e\fP option if you are sure the console is physically protected against unauthorized access. .SH AUTHOR Miquel van Smoorenburg