diff options
author | Alejandro Colomar <alx@kernel.org> | 2023-10-31 01:28:55 +0100 |
---|---|---|
committer | Alejandro Colomar <alx@kernel.org> | 2023-10-31 01:37:57 +0100 |
commit | c6d039a3a6edcffa325c584d9942fc64560c32e1 (patch) | |
tree | fe4ac58f924a952635fa4018af95db9d8f64ec62 /man4 | |
parent | 019aad50584289476a9f206adf074326e106713d (diff) |
man*/: srcfix (Use .P instead of .PP or .LP)
We're trying to "standardize" on a paragraphing macro from the three
equivalent ones (P, PP, LP). We (somewhat arbitrarily) agreed on P.
Scripted change:
$ find man* -type f | xargs sed -i '/\.PP/s/PP/P/'
$ find man* -type f | xargs sed -i '/\.LP/s/LP/P/'
Suggested-by: "G. Branden Robinson" <branden@debian.org>
Cc: Ingo Schwarze <schwarze@openbsd.org>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
Diffstat (limited to 'man4')
-rw-r--r-- | man4/cciss.4 | 38 | ||||
-rw-r--r-- | man4/console_codes.4 | 104 | ||||
-rw-r--r-- | man4/cpuid.4 | 22 | ||||
-rw-r--r-- | man4/dsp56k.4 | 8 | ||||
-rw-r--r-- | man4/fd.4 | 20 | ||||
-rw-r--r-- | man4/full.4 | 8 | ||||
-rw-r--r-- | man4/fuse.4 | 14 | ||||
-rw-r--r-- | man4/hd.4 | 8 | ||||
-rw-r--r-- | man4/hpsa.4 | 10 | ||||
-rw-r--r-- | man4/initrd.4 | 28 | ||||
-rw-r--r-- | man4/lirc.4 | 12 | ||||
-rw-r--r-- | man4/loop.4 | 12 | ||||
-rw-r--r-- | man4/mem.4 | 22 | ||||
-rw-r--r-- | man4/mouse.4 | 20 | ||||
-rw-r--r-- | man4/msr.4 | 6 | ||||
-rw-r--r-- | man4/null.4 | 8 | ||||
-rw-r--r-- | man4/pts.4 | 12 | ||||
-rw-r--r-- | man4/ram.4 | 4 | ||||
-rw-r--r-- | man4/random.4 | 36 | ||||
-rw-r--r-- | man4/rtc.4 | 28 | ||||
-rw-r--r-- | man4/sd.4 | 8 | ||||
-rw-r--r-- | man4/sk98lin.4 | 30 | ||||
-rw-r--r-- | man4/smartpqi.4 | 2 | ||||
-rw-r--r-- | man4/st.4 | 58 | ||||
-rw-r--r-- | man4/tty.4 | 6 | ||||
-rw-r--r-- | man4/ttyS.4 | 4 | ||||
-rw-r--r-- | man4/vcs.4 | 28 | ||||
-rw-r--r-- | man4/veth.4 | 20 | ||||
-rw-r--r-- | man4/wavelan.4 | 4 |
29 files changed, 290 insertions, 290 deletions
diff --git a/man4/cciss.4 b/man4/cciss.4 index 873ef9118..a3fadb5d1 100644 --- a/man4/cciss.4 +++ b/man4/cciss.4 @@ -20,7 +20,7 @@ This obsolete driver was removed in Linux 4.14, as it is superseded by the .BR hpsa (4) driver in newer kernels. -.PP +.P .B cciss is a block driver for older HP Smart Array RAID controllers. .SS Options @@ -32,7 +32,7 @@ driver from attempting to drive any controllers that the driver is capable of controlling, which is to say, the .B cciss driver is restricted by this option to the following controllers: -.PP +.P .nf Smart Array 5300 Smart Array 5i @@ -56,7 +56,7 @@ driver is restricted by this option to the following controllers: The .B cciss driver supports the following Smart Array boards: -.PP +.P .nf Smart Array 5300 Smart Array 5i @@ -95,7 +95,7 @@ run from the Smart Array's option ROM at boot time. .SH FILES .SS Device nodes The device naming scheme is as follows: -.PP +.P Major numbers: .IP .TS @@ -109,9 +109,9 @@ r r. 110 cciss6 111 cciss7 .TE -.PP +.P Minor numbers: -.PP +.P .EX b7 b6 b5 b4 b3 b2 b1 b0 |\-\-\-\-+\-\-\-\-| |\-\-\-\-+\-\-\-\-| @@ -120,7 +120,7 @@ Minor numbers: | +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- Logical Volume number .EE -.PP +.P The device naming scheme is: .TS li l. @@ -140,7 +140,7 @@ The files contain information about the configuration of each controller. For example: -.PP +.P .in +4n .EX $ \fBcd /proc/driver/cciss\fP @@ -237,7 +237,7 @@ for more details.) You must enable "SCSI tape drive support for Smart Array 5xxx" and "SCSI support" in your kernel configuration to be able to use SCSI tape drives with your Smart Array 5xxx controller. -.PP +.P Additionally, note that the driver will not engage the SCSI core at init time. The driver must be directed to dynamically engage the SCSI core via the @@ -255,7 +255,7 @@ This is best done via an initialization script .IR /etc/init.d , but could vary depending on distribution). For example: -.PP +.P .in +4n .EX for x in /proc/driver/cciss/cciss[0\-9]* @@ -264,10 +264,10 @@ do done .EE .in -.PP +.P Once the SCSI core is engaged by the driver, it cannot be disengaged (except by unloading the driver, if it happens to be linked as a module.) -.PP +.P Note also that if no sequential access devices or medium changers are detected, the SCSI core will not be engaged by the action of the above script. @@ -283,7 +283,7 @@ filesystem. For example: .IP echo "rescan" > /proc/scsi/cciss0/1 -.PP +.P This causes the driver to: .RS .IP (1) 5 @@ -293,20 +293,20 @@ physical SCSI buses and/or fiber channel arbitrated loop, and make note of any new or removed sequential access devices or medium changers. .RE -.PP +.P The driver will output messages indicating which devices have been added or removed and the controller, bus, target, and lun used to address each device. The driver then notifies the SCSI midlayer of these changes. -.PP +.P Note that the naming convention of the .I /proc filesystem entries contains a number in addition to the driver name (e.g., "cciss0" instead of just "cciss", which you might expect). -.PP +.P Note: .I Only sequential access devices and medium changers are presented @@ -340,7 +340,7 @@ If that doesn't work, the device is reset. If that doesn't work, the SCSI bus is reset. .IP (4) If that doesn't work, the host bus adapter is reset. -.PP +.P The .B cciss driver is a block @@ -358,7 +358,7 @@ in aborting commands, and sometimes it appears they will not even obey a reset command, though in most circumstances they will. If the command cannot be aborted and the device cannot be reset, the device will be set offline. -.PP +.P In the event that the error-handling code is triggered and a tape drive is successfully reset or the tardy command is successfully aborted, the tape drive may still not allow I/O to continue until some command @@ -371,7 +371,7 @@ for example) before I/O can proceed again to a tape drive that was reset. .BR cciss_vol_status (8), .BR hpacucli (8), .BR hpacuxe (8) -.PP +.P .UR http://cciss.sf.net .UE , and diff --git a/man4/console_codes.4 b/man4/console_codes.4 index 5fc7f0b73..8a7c1d3a4 100644 --- a/man4/console_codes.4 +++ b/man4/console_codes.4 @@ -25,31 +25,31 @@ for changing the color palette, character-set mapping, and so on. In the tabular descriptions below, the second column gives ECMA-48 or DEC mnemonics (the latter if prefixed with DEC) for the given function. Sequences without a mnemonic are neither ECMA-48 nor VT102. -.PP +.P After all the normal output processing has been done, and a stream of characters arrives at the console driver for actual printing, the first thing that happens is a translation from the code used for processing to the code used for printing. -.PP +.P If the console is in UTF-8 mode, then the incoming bytes are first assembled into 16-bit Unicode codes. Otherwise, each byte is transformed according to the current mapping table (which translates it to a Unicode value). See the \fBCharacter Sets\fP section below for discussion. -.PP +.P In the normal case, the Unicode value is converted to a font index, and this is stored in video memory, so that the corresponding glyph (as found in video ROM) appears on the screen. Note that the use of Unicode (and the design of the PC hardware) allows us to use 512 different glyphs simultaneously. -.PP +.P If the current Unicode value is a control character, or we are currently processing an escape sequence, the value will treated specially. Instead of being turned into a font index and rendered as a glyph, it may trigger cursor movement or other control functions. See the \fBLinux Console Controls\fP section below for discussion. -.PP +.P It is generally not good practice to hard-wire terminal controls into programs. Linux supports a @@ -65,9 +65,9 @@ or This section describes all the control characters and escape sequences that invoke special functions (i.e., anything other than writing a glyph at the current cursor location) on the Linux console. -.PP +.P .B "Control characters" -.PP +.P A character is a control character if (before transformation according to the mapping table) it has one of the 14 codes 00 (NUL), 07 (BEL), 08 (BS), 09 (HT), 0a (LF), 0b (VT), @@ -78,7 +78,7 @@ and allow 07, 09, 0b, 18, 1a, 7f to be displayed as glyphs. On the other hand, in UTF-8 mode all codes 00\[en]1f are regarded as control characters, regardless of any "display control characters" mode. -.PP +.P If we have a control character, it is acted upon immediately and then discarded (even in the middle of an escape sequence) and the escape sequence continues with the next character. @@ -129,7 +129,7 @@ is ignored; .TP CSI (0x9B) is equivalent to ESC [. -.PP +.P .B "ESC- but not CSI-sequences" .ad l .TS @@ -190,19 +190,19 @@ the red/green/blue values (0\[en]255). T} .TE .ad -.PP +.P .B "ECMA-48 CSI sequences" -.PP +.P CSI (or ESC [) is followed by a sequence of parameters, at most NPAR (16), that are decimal numbers separated by semicolons. An empty or absent parameter is taken to be 0. The sequence of parameters may be preceded by a single question mark. -.PP +.P However, after CSI [ (or ESC [ [) a single character is read and this entire sequence is ignored. (The idea is to ignore an echoed function key.) -.PP +.P The action of a CSI sequence is determined by its final character. .ad l .TS @@ -309,9 +309,9 @@ Move cursor to indicated column in current row. T} .TE .ad -.PP +.P .B ECMA-48 Select Graphic Rendition -.PP +.P The ECMA-48 SGR sequence ESC [ \fIparameters\fP m sets display attributes. Several attributes can be set in the same sequence, separated by @@ -397,7 +397,7 @@ set background, same as 40..47 (bright not supported) T} .TE .ad -.PP +.P Commands 38 and 48 require further arguments: .TS l lx. @@ -409,7 +409,7 @@ T} 24-bit color, r/g/b components are in the range 0..255 T} .TE -.PP +.P .B ECMA-48 Mode Switches .TP ESC [ 3 h @@ -421,7 +421,7 @@ DECIM (default off): Set insert mode. ESC [ 20 h LF/NL (default off): Automatically follow echo of LF, VT, or FF with CR. .\" -.PP +.P .B ECMA-48 Status Report Commands .\" .TP @@ -432,9 +432,9 @@ ESC [ 6 n Cursor position report (CPR): Answer is ESC [ \fIy\fP ; \fIx\fP R, where \fIx,y\fP is the cursor location. .\" -.PP +.P .B DEC Private Mode (DECSET/DECRST) sequences -.PP +.P .\" These are not described in ECMA-48. We list the Set Mode sequences; @@ -479,9 +479,9 @@ ESC [ ? 1000 h X11 Mouse Reporting (default off): Set reporting mode to 2 (or reset to 0)\[em]see below. .\" -.PP +.P .B Linux Console Private CSI Sequences -.PP +.P .\" The following sequences are neither ECMA-48 nor native VT102. They are native to the Linux console driver. @@ -532,13 +532,13 @@ The kernel knows about 4 translations of bytes into console-screen symbols. The four tables are: a) Latin1 \-> PC, b) VT100 graphics \-> PC, c) PC \-> PC, d) user-defined. -.PP +.P There are two character sets, called G0 and G1, and one of them is the current character set. (Initially G0.) Typing \fB\[ha]N\fP causes G1 to become current, \fB\[ha]O\fP causes G0 to become current. -.PP +.P These variables G0 and G1 point at a translation table, and can be changed by the user. Initially they point at tables a) and b), respectively. @@ -546,7 +546,7 @@ The sequences ESC ( B and ESC ( 0 and ESC ( U and ESC ( K cause G0 to point at translation table a), b), c), and d), respectively. The sequences ESC ) B and ESC ) 0 and ESC ) U and ESC ) K cause G1 to point at translation table a), b), c), and d), respectively. -.PP +.P The sequence ESC c causes a terminal reset, which is what you want if the screen is all garbled. The oft-advised "echo \[ha]V\[ha]O" will make only G0 current, @@ -556,7 +556,7 @@ In some distributions there is a program that just does "echo \[ha][c". If your terminfo entry for the console is correct (and has an entry rs1=\eEc), then "tput reset" will also work. -.PP +.P The user-defined mapping table can be set using .BR mapscrn (8). The result of the mapping is that if a symbol c is printed, the symbol @@ -576,13 +576,13 @@ These ioctls must be generated by a mouse-aware user-mode application such as the .BR gpm (8) daemon. -.PP +.P The mouse tracking escape sequences generated by \fBxterm\fP(1) encode numeric parameters in a single character as \fIvalue\fP+040. For example, \[aq]!\[aq] is 1. The screen coordinate system is 1-based. -.PP +.P The X10 compatibility mode sends an escape sequence on button press encoding the location and the mouse button pressed. It is enabled by sending ESC [ ? 9 h and disabled with ESC [ ? 9 l. @@ -592,7 +592,7 @@ Here \fIb\fP is button\-1, and \fIx\fP and \fIy\fP are the x and y coordinates of the mouse when the button was pressed. This is the same code the kernel also produces. -.PP +.P Normal tracking mode (not implemented in Linux 2.0.24) sends an escape sequence on both button press and release. Modifier information is also sent. @@ -614,9 +614,9 @@ Here we discuss differences between the Linux console and the two most important others, the DEC VT102 and .BR xterm (1). .\" -.PP +.P .B Control-character handling -.PP +.P The VT102 also recognized the following control characters: .TP NUL (0x00) @@ -631,17 +631,17 @@ resumed transmission; DC3 (0x13, \fB\[ha]S\fP, XOFF) caused VT100 to ignore (and stop transmitting) all codes except XOFF and XON. -.PP +.P VT100-like DC1/DC3 processing may be enabled by the terminal driver. -.PP +.P The .BR xterm (1) program (in VT100 mode) recognizes the control characters BEL, BS, HT, LF, VT, FF, CR, SO, SI, ESC. .\" -.PP +.P .B Escape sequences -.PP +.P VT100 console sequences not implemented on the Linux console: .TS l l l. @@ -660,7 +660,7 @@ ESC \e ST String terminator ESC * ... Designate G2 character set ESC + ... Designate G3 character set .TE -.PP +.P The program .BR xterm (1) (in VT100 mode) recognizes ESC c, ESC # 8, ESC >, ESC =, @@ -671,11 +671,11 @@ and ESC \[ha] ... ESC \e with the same meanings as indicated above. It accepts ESC (, ESC ), ESC *, ESC + followed by 0, A, B for the DEC special character and line drawing set, UK, and US-ASCII, respectively. -.PP +.P The user can configure \fBxterm\fP(1) to respond to VT220-specific control sequences, and it will identify itself as a VT52, VT100, and up depending on the way it is configured and initialized. -.PP +.P It accepts ESC ] (OSC) for the setting of certain resources. In addition to the ECMA-48 string terminator (ST), \fBxterm\fP(1) accepts a BEL to terminate an OSC string. @@ -694,7 +694,7 @@ Change log file to \fIname\fP (normally disabled by a compile-time option). T} ESC ] 5 0 ; \fIfn\fP ST Set font to \fIfn\fP. .TE -.PP +.P It recognizes the following with slightly modified meaning (saving more state, behaving closer to VT100/VT220): .TS @@ -702,7 +702,7 @@ l l l. ESC 7 DECSC Save cursor ESC 8 DECRC Restore cursor .TE -.PP +.P It also recognizes .TS l l lx. @@ -719,13 +719,13 @@ ESC | LS3R Invoke the G3 character set as GR. ESC } LS2R Invoke the G2 character set as GR. ESC \[ti] LS1R Invoke the G1 character set as GR. .TE -.PP +.P It also recognizes ESC % and provides a more complete UTF-8 implementation than Linux console. .\" -.PP +.P .B CSI Sequences -.PP +.P Old versions of \fBxterm\fP(1), for example, from X11R5, interpret the blink SGR as a bold SGR. Later versions which implemented ANSI colors, for example, @@ -739,7 +739,7 @@ All ECMA-48 CSI sequences recognized by Linux are also recognized by .IR xterm , however \fBxterm\fP(1) implements several ECMA-48 and DEC control sequences not recognized by Linux. -.PP +.P The \fBxterm\fP(1) program recognizes all of the DEC Private Mode sequences listed above, but none of the Linux private-mode sequences. @@ -753,21 +753,21 @@ and Thomas E.\& Dickey available with the X distribution. That document, though terse, is much longer than this manual page. For a chronological overview, -.PP +.P .RS .UR http://invisible\-island.net\:/xterm\:/xterm.log.html .UE .RE -.PP +.P details changes to xterm. -.PP +.P The \fIvttest\fP program -.PP +.P .RS .UR http://invisible\-island.net\:/vttest/ .UE .RE -.PP +.P demonstrates many of these control sequences. The \fBxterm\fP(1) source distribution also contains sample scripts which exercise other features. @@ -777,7 +777,7 @@ ESC %. .SH BUGS In Linux 2.0.23, CSI is broken, and NUL is not ignored inside escape sequences. -.PP +.P Some older kernel versions (after Linux 2.0) interpret 8-bit control sequences. These "C1 controls" use codes between 128 and 159 to replace @@ -786,7 +786,7 @@ There are fragments of that in modern kernels (either overlooked or broken by changes to support UTF-8), but the implementation is incomplete and should be regarded as unreliable. -.PP +.P Linux "private mode" sequences do not follow the rules in ECMA-48 for private mode control sequences. In particular, those ending with ] do not use a standard terminating @@ -801,7 +801,7 @@ will fix that). To accommodate applications which have been hardcoded to use Linux control sequences, set the \fBxterm\fP(1) resource \fBbrokenLinuxOSC\fP to true. -.PP +.P An older version of this document implied that Linux recognizes the ECMA-48 control sequence for invisible text. It is ignored. diff --git a/man4/cpuid.4 b/man4/cpuid.4 index c89d27062..bd883e6d3 100644 --- a/man4/cpuid.4 +++ b/man4/cpuid.4 @@ -8,14 +8,14 @@ cpuid \- x86 CPUID access device .SH DESCRIPTION CPUID provides an interface for querying information about the x86 CPU. -.PP +.P This device is accessed by .BR lseek (2) or .BR pread (2) to the appropriate CPUID level and reading in chunks of 16 bytes. A larger read size means multiple reads of consecutive levels. -.PP +.P The lower 32 bits of the file position is used as the incoming .IR %eax , and the upper 32 bits of the file position as the incoming @@ -24,7 +24,7 @@ the latter is intended for "counting" .I eax levels like .IR eax=4 . -.PP +.P This driver uses .IR /dev/cpu/CPUNUM/cpuid , where @@ -34,7 +34,7 @@ and on an SMP box will direct the access to CPU .I CPUNUM as listed in .IR /proc/cpuinfo . -.PP +.P This file is protected so that it can be read only by the user .IR root , or members of the group @@ -44,7 +44,7 @@ The CPUID instruction can be directly executed by a program using inline assembler. However this device allows convenient access to all CPUs without changing process affinity. -.PP +.P Most of the information in .I cpuid is reported by the kernel in cooked form either in @@ -53,29 +53,29 @@ or through subdirectories in .IR /sys/devices/system/cpu . Direct CPUID access through this device should only be used in exceptional cases. -.PP +.P The .I cpuid driver is not auto-loaded. On modular kernels you might need to use the following command to load it explicitly before use: -.PP +.P .in +4n .EX $ modprobe cpuid .EE .in -.PP +.P There is no support for CPUID functions that require additional input registers. -.PP +.P Very old x86 CPUs don't support CPUID. .SH SEE ALSO .BR cpuid (1) -.PP +.P Intel Corporation, Intel 64 and IA-32 Architectures Software Developer's Manual Volume 2A: Instruction Set Reference, A-M, 3-180 CPUID reference. -.PP +.P Intel Corporation, Intel Processor Identification and the CPUID Instruction, Application note 485. diff --git a/man4/dsp56k.4 b/man4/dsp56k.4 index 6e2baeb4e..62b53700d 100644 --- a/man4/dsp56k.4 +++ b/man4/dsp56k.4 @@ -10,10 +10,10 @@ dsp56k \- DSP56001 interface device .SH SYNOPSIS .nf .B #include <asm/dsp56k.h> -.PP +.P .BI "ssize_t read(int " fd ", void *" data ", size_t " length ); .BI "ssize_t write(int " fd ", void *" data ", size_t " length ); -.PP +.P .BI "int ioctl(int " fd ", DSP56K_UPLOAD, struct dsp56k_upload *" program ); .BI "int ioctl(int " fd ", DSP56K_SET_TX_WSIZE, int " wsize ); .BI "int ioctl(int " fd ", DSP56K_SET_RX_WSIZE, int " wsize ); @@ -31,7 +31,7 @@ processor found in Atari Falcon030-compatible computers. The \fIdsp56k\fP special file is used to control the DSP56001, and to send and receive data using the bidirectional handshaked host port. -.PP +.P To send a data stream to the signal processor, use .BR write (2) to the @@ -41,7 +41,7 @@ to receive processed data. The data can be sent or received in 8, 16, 24, or 32-bit quantities on the host side, but will always be seen as 24-bit quantities in the DSP56001. -.PP +.P The following .BR ioctl (2) calls are used to control the @@ -26,14 +26,14 @@ number on its controller and 128 if the drive is on the secondary controller. In the following device tables, \fIn\fP represents the drive number. -.PP +.P \fBWarning: if you use formats with more tracks than supported by your drive, you may cause it mechanical damage.\fP Trying once if more tracks than the usual 40/80 are supported should not damage it, but no warranty is given for that. If you are not sure, don't create device entries for those formats, so as to prevent their usage. -.PP +.P Drive-independent device files which automatically detect the media format and capacity: .TS @@ -44,7 +44,7 @@ Name Base _ \fBfd\fP\fIn\fP 0 .TE -.PP +.P 5.25 inch double-density device files: .TS lw(1i) l l l l c @@ -54,7 +54,7 @@ Name Capacity Cyl. Sect. Heads Base _ \fBfd\fP\fIn\fP\fBd360\fP 360 40 9 2 4 .TE -.PP +.P 5.25 inch high-density device files: .TS lw(1i) l l l l c @@ -73,7 +73,7 @@ _ \fBfd\fP\fIn\fP\fBh1494\fP 1494 83 18 2 72 \fBfd\fP\fIn\fP\fBh1600\fP 1600 80 20 2 92 .TE -.PP +.P 3.5 inch double-density device files: .TS lw(1i) l l l l c @@ -87,7 +87,7 @@ _ \fBfd\fP\fIn\fP\fBu1040\fP 1040 80 13 2 84 \fBfd\fP\fIn\fP\fBu1120\fP 1120 80 14 2 88 .TE -.PP +.P 3.5 inch high-density device files: .TS lw(1i) l l l l c @@ -108,7 +108,7 @@ _ \fBfd\fP\fIn\fP\fBu1840\fP 1840 80 23 2 116 \fBfd\fP\fIn\fP\fBu1920\fP 1920 80 24 2 100 .TE -.PP +.P 3.5 inch extra-density device files: .TS lw(1i) l l l l c @@ -198,7 +198,7 @@ resets the floppy controller under certain conditions. .TP .B FDRAWCMD sends a raw command to the floppy controller. -.PP +.P For more precise information, consult also the \fI<linux/fd.h>\fP and \fI<linux/fdreg.h>\fP include files, as well as the .BR floppycontrol (1) @@ -211,11 +211,11 @@ However, if a floppy is formatted with an inter-sector gap that is too small, performance may drop, to the point of needing a few seconds to access an entire track. To prevent this, use interleaved formats. -.PP +.P It is not possible to read floppies which are formatted using GCR (group code recording), which is used by Apple II and Macintosh computers (800k disks). -.PP +.P Reading floppies which are hard sectored (one hole per sector, with the index hole being a little skewed) is not supported. This used to be common with older 8-inch floppies. diff --git a/man4/full.4 b/man4/full.4 index e3c3de215..92c440bc6 100644 --- a/man4/full.4 +++ b/man4/full.4 @@ -11,7 +11,7 @@ If your system does not have .I /dev/full created already, it can be created with the following commands: -.PP +.P .in +4n .EX mknod \-m 666 /dev/full c 1 7 @@ -23,18 +23,18 @@ The file .I /dev/full has major device number 1 and minor device number 7. -.PP +.P Writes to the .I /dev/full device fail with an .B ENOSPC error. This can be used to test how a program handles disk-full errors. -.PP +.P Reads from the .I /dev/full device will return \e0 characters. -.PP +.P Seeks on .I /dev/full will always succeed. diff --git a/man4/fuse.4 b/man4/fuse.4 index 612070787..1e2dd7ae5 100644 --- a/man4/fuse.4 +++ b/man4/fuse.4 @@ -21,7 +21,7 @@ Those implementing a FUSE filesystem may wish to make use of a user-space library such as .I libfuse that abstracts away the low-level interface. -.PP +.P At its core, FUSE is a simple client-server protocol, in which the Linux kernel is the client and the daemon is the server. After obtaining a file descriptor for this device, the daemon may @@ -38,7 +38,7 @@ through the first file descriptor (and vice versa). .SS The basic protocol Every message that is read by the daemon begins with a header described by the following structure: -.PP +.P .in +4n .EX struct fuse_in_header { @@ -55,19 +55,19 @@ struct fuse_in_header { }; .EE .in -.PP +.P The header is followed by a variable-length data portion (which may be empty) specific to the requested operation (the requested operation is indicated by .IR opcode ). -.PP +.P The daemon should then process the request and if applicable send a reply (almost all operations require a reply; if they do not, this is documented below), by performing a .BR write (2) to the file descriptor. All replies must start with the following header: -.PP +.P .in +4n .EX struct fuse_out_header { @@ -79,7 +79,7 @@ struct fuse_out_header { }; .EE .in -.PP +.P This header is also followed by (potentially empty) variable-sized data depending on the executed request. However, if the reply is an error reply (i.e., @@ -494,7 +494,7 @@ file descriptor that has not been mounted. Linux. .SH NOTES The following messages are not yet documented in this manual page: -.PP +.P .\" FIXME: Document the following. .in +4n .EX @@ -25,7 +25,7 @@ is .B hdc and the slave is .BR hdd . -.PP +.P General IDE block device names have the form .BI hd X\c , or @@ -49,15 +49,15 @@ Thus, the first logical partition will be \&. Both DOS-type partitioning and BSD-disklabel partitioning are supported. You can have at most 63 partitions on an IDE disk. -.PP +.P For example, .I /dev/hda refers to all of the first IDE drive in the system; and .I /dev/hdb3 refers to the third DOS "primary" partition on the second one. -.PP +.P They are typically created by: -.PP +.P .in +4n .EX mknod \-m 660 /dev/hda b 3 0 diff --git a/man4/hpsa.4 b/man4/hpsa.4 index 856d205f6..6c24c9cb0 100644 --- a/man4/hpsa.4 +++ b/man4/hpsa.4 @@ -38,7 +38,7 @@ should still be used for these. The .B hpsa driver supports the following Smart Array boards: -.PP +.P .nf Smart Array P700M Smart Array P212 @@ -50,10 +50,10 @@ driver supports the following Smart Array boards: Smart Array P711m StorageWorks P1210m .fi -.PP +.P .\" commit 135ae6edeb51979d0998daf1357f149a7d6ebb08 Since Linux 4.14, the following Smart Array boards are also supported: -.PP +.P .nf Smart Array 5300 Smart Array 5312 @@ -161,7 +161,7 @@ This attribute contains the 16 hex-digit (8 byte) LUN ID by which a logical drive or physical device can be addressed. .IR c : b : t : l are the controller, bus, target, and lun of the device. -.PP +.P For example: .IP .in +4n @@ -227,7 +227,7 @@ for some examples. .BR cciss_vol_status (8), .BR hpacucli (8), .BR hpacuxe (8) -.PP +.P .UR http://cciss.sf.net .UE , and diff --git a/man4/initrd.4 b/man4/initrd.4 index 08df8e6a9..6c63d6b13 100644 --- a/man4/initrd.4 +++ b/man4/initrd.4 @@ -27,14 +27,14 @@ with mode 0400 (read access by root only). If the Linux system does not have .I /dev/initrd already created, it can be created with the following commands: -.PP +.P .in +4n .EX mknod \-m 400 /dev/initrd b 1 250 chown root:disk /dev/initrd .EE .in -.PP +.P Also, support for both "RAM disk" and "Initial RAM disk" (e.g., .B CONFIG_BLK_DEV_RAM=y @@ -57,7 +57,7 @@ by the boot loader before the kernel is started. The kernel then can use .IR /dev/initrd "'s" contents for a two-phase system boot-up. -.PP +.P In the first boot-up phase, the kernel starts up and mounts an initial root filesystem from the contents of .I /dev/initrd @@ -233,7 +233,7 @@ For more information on setting the root filesystem see also the and .B LOADLIN documentation. -.PP +.P It is also possible for the .I /linuxrc executable to change the normal root device. @@ -265,19 +265,19 @@ and then writing 0xff (e.g., the pseudo-NFS-device number) into file For example, the following shell command line would change the normal root device to .IR /dev/hdb1 : -.PP +.P .in +4n .EX echo 0x365 >/proc/sys/kernel/real\-root\-dev .EE .in -.PP +.P For an NFS example, the following shell command lines would change the normal root device to the NFS directory .I /var/nfsroot on a local networked NFS server with IP number 193.8.232.7 for a system with IP number 193.8.232.2 and named "idefix": -.PP +.P .in +4n .EX echo /var/nfsroot >/proc/sys/kernel/nfs\-root\-name @@ -286,7 +286,7 @@ echo 193.8.232.2:193.8.232.7::255.255.255.0:idefix \e echo 255 >/proc/sys/kernel/real\-root\-dev .EE .in -.PP +.P .BR Note : The use of .I /proc/sys/kernel/real\-root\-dev @@ -310,7 +310,7 @@ for information on the modern method of changing the root filesystem. The main motivation for implementing .B initrd was to allow for modular kernel configuration at system installation. -.PP +.P A possible system installation scenario is as follows: .IP (1) 5 The loader program boots from floppy or other media with a minimal kernel @@ -364,13 +364,13 @@ to a file.) .IP (9) The system is now bootable and additional installation tasks can be performed. -.PP +.P The key role of .I /dev/initrd in the above is to reuse the configuration data during normal system operation without requiring initial kernel selection, a large generic kernel or, recompiling the kernel. -.PP +.P A second scenario is for installations where Linux runs on systems with different hardware configurations in a single administrative network. In such cases, it may be desirable to use only a small set of kernels @@ -383,14 +383,14 @@ Then, only the file or a file executed by .I /linuxrc would be different. -.PP +.P A third scenario is more convenient recovery disks. Because information like the location of the root filesystem partition is not needed at boot time, the system loaded from .I /dev/initrd can use a dialog and/or auto-detection followed by a possible sanity check. -.PP +.P Last but not least, Linux distributions on CD-ROM may use .B initrd for easy installation from the CD-ROM. @@ -469,7 +469,7 @@ The behavior may change in future versions of the Linux kernel. .BR ram (4), .BR freeramdisk (8), .BR rdev (8) -.PP +.P .I Documentation/admin\-guide/initrd.rst .\" commit 9d85025b0418163fae079c9ba8f8445212de8568 (or diff --git a/man4/lirc.4 b/man4/lirc.4 index 98ec06769..ae1caafcf 100644 --- a/man4/lirc.4 +++ b/man4/lirc.4 @@ -13,7 +13,7 @@ bidirectional interface to infra-red (IR) remotes. Most of these devices can receive, and some can send. When receiving or sending data, the driver works in two different modes depending on the underlying hardware. -.PP +.P Some hardware (typically TV-cards) decodes the IR signal internally and provides decoded button presses as scancode values. Drivers for this kind of hardware work in @@ -23,7 +23,7 @@ Such hardware usually does not support sending IR signals. Furthermore, such hardware can only decode a limited set of IR protocols, usually only the protocol of the specific remote which is bundled with, for example, a TV-card. -.PP +.P Other hardware provides a stream of pulse/space durations. Such drivers work in .B LIRC_MODE_MODE2 @@ -39,7 +39,7 @@ and attached to the device. Sometimes, this kind of hardware also supports sending IR data. -.PP +.P The \fBLIRC_GET_FEATURES\fR ioctl (see below) allows probing for whether receiving and sending is supported, and in which modes, amongst other features. @@ -119,7 +119,7 @@ device cannot transmit. \& int ioctl(int fd, int cmd, int *val); .fi -.PP +.P The following .BR ioctl (2) operations are provided by the @@ -132,7 +132,7 @@ hardware settings. .TP 4 .BR LIRC_GET_FEATURES " (\fIvoid\fP)" Returns a bit mask of combined features bits; see FEATURES. -.PP +.P If a device returns an error code for .BR LIRC_GET_FEATURES , it is safe to assume it is not a @@ -418,6 +418,6 @@ Users of older kernels could use the file bundled in .\" .SH SEE ALSO \fBir\-ctl\fP(1), \fBlircd\fP(8),\ \fBbpf\fP(2) -.PP +.P .UR https://www.kernel.org/\:doc/\:html/\:latest/\:userspace\-api/\:media/\:rc/\:lirc\-dev.html .UE diff --git a/man4/loop.4 b/man4/loop.4 index b156de505..253784a34 100644 --- a/man4/loop.4 +++ b/man4/loop.4 @@ -20,7 +20,7 @@ image stored in a file, so that it can be mounted with the .BR mount (8) command. You could do -.PP +.P .in +4n .EX $ \fBdd if=/dev/zero of=file.img bs=1MiB count=10\fP @@ -30,14 +30,14 @@ $ \fBsudo mkdir /myloopdev\fP $ \fBsudo mount /dev/loop4 /myloopdev\fP .EE .in -.PP +.P See .BR losetup (8) for another example. -.PP +.P A transfer function can be specified for each loop device for encryption and decryption purposes. -.PP +.P The following .BR ioctl (2) operations are provided by the loop block device: @@ -214,7 +214,7 @@ explicitly request read-only mode by setting in .IR loop_config.info.lo_flags . .RE -.PP +.P Since Linux 2.6, there are two new .BR ioctl (2) operations: @@ -295,7 +295,7 @@ device to find a free loop device, opens the loop device, opens a file to be used as the underlying storage for the device, and then associates the loop device with the backing store. The following shell session demonstrates the use of the program: -.PP +.P .in +4n .EX $ \fBdd if=/dev/zero of=file.img bs=1MiB count=10\fP diff --git a/man4/mem.4 b/man4/mem.4 index 333cef800..5bc14bbb6 100644 --- a/man4/mem.4 +++ b/man4/mem.4 @@ -12,31 +12,31 @@ mem, kmem, port \- system memory, kernel memory and system ports is a character device file that is an image of the main memory of the computer. It may be used, for example, to examine (and even patch) the system. -.PP +.P Byte addresses in .I /dev/mem are interpreted as physical memory addresses. References to nonexistent locations cause errors to be returned. -.PP +.P Examining and patching is likely to lead to unexpected results when read-only or write-only bits are present. -.PP +.P Since Linux 2.6.26, and depending on the architecture, the .B CONFIG_STRICT_DEVMEM kernel configuration option limits the areas which can be accessed through this file. For example: on x86, RAM access is not allowed but accessing memory-mapped PCI regions is. -.PP +.P It is typically created by: -.PP +.P .in +4n .EX mknod \-m 660 /dev/mem c 1 1 chown root:kmem /dev/mem .EE .in -.PP +.P The file .I /dev/kmem is the same as @@ -46,23 +46,23 @@ rather than physical memory is accessed. Since Linux 2.6.26, this file is available only if the .B CONFIG_DEVKMEM kernel configuration option is enabled. -.PP +.P It is typically created by: -.PP +.P .in +4n .EX mknod \-m 640 /dev/kmem c 1 2 chown root:kmem /dev/kmem .EE .in -.PP +.P .I /dev/port is similar to .IR /dev/mem , but the I/O ports are accessed. -.PP +.P It is typically created by: -.PP +.P .in +4n .EX mknod \-m 660 /dev/port c 1 4 diff --git a/man4/mouse.4 b/man4/mouse.4 index 309f6ad42..1a08c15d8 100644 --- a/man4/mouse.4 +++ b/man4/mouse.4 @@ -13,7 +13,7 @@ for a description. .SH DESCRIPTION .SS Introduction The pinout of the usual 9 pin plug as used for serial mice is: -.PP +.P .TS center; r c l. @@ -24,15 +24,15 @@ pin name used for 7 RTS +12 V, Imax = 10 mA 5 GND Ground .TE -.PP +.P This is the specification, in fact 9 V suffices with most mice. -.PP +.P The mouse driver can recognize a mouse by dropping RTS to low and raising it again. About 14 ms later the mouse will send 0x4D (\[aq]M\[aq]) on the data line. After a further 63 ms, a Microsoft-compatible 3-button mouse will send 0x33 (\[aq]3\[aq]). -.PP +.P The relative mouse movement is sent as .I dx (positive means right) @@ -44,7 +44,7 @@ To select speeds, cycle through the speeds 9600, 4800, 2400, and 1200 bit/s, each time writing the two characters from the table below and waiting 0.1 seconds. The following table shows available speeds and the strings that select them: -.PP +.P .TS center; l l. @@ -54,7 +54,7 @@ bit/s string 2400 *o 1200 *n .TE -.PP +.P The first byte of a data packet can be used for synchronization purposes. .SS Microsoft protocol The @@ -72,7 +72,7 @@ two's-complement, .RI ( rb ) are set when the left (right) button is pressed: -.PP +.P .TS center; r c c c c c c c. @@ -117,7 +117,7 @@ values. .IR rb ) are cleared when the left (middle, right) button is pressed: -.PP +.P .TS center; r c c c c c c c c. @@ -128,7 +128,7 @@ byte d7 d6 d5 d4 d3 d2 d1 d0 4 0 dxb6 dxb5 dxb4 dxb3 dxb2 dxb1 dxb0 5 0 dyb6 dyb5 dyb4 dyb3 dyb2 dyb1 dyb0 .TE -.PP +.P Bytes 4 and 5 describe the change that occurred since bytes 2 and 3 were transmitted. .SS Sun protocol @@ -153,7 +153,7 @@ sign bit indicating a negative value. .IR rb ) are set when the left (middle, right) button is pressed: -.PP +.P .TS center; r c c c c c c c c. diff --git a/man4/msr.4 b/man4/msr.4 index a11a71cd0..d6b859e1b 100644 --- a/man4/msr.4 +++ b/man4/msr.4 @@ -13,13 +13,13 @@ registers (MSRs) of an x86 CPU. .I CPUNUM is the number of the CPU to access as listed in .IR /proc/cpuinfo . -.PP +.P The register access is done by opening the file and seeking to the MSR number as offset in the file, and then reading or writing in chunks of 8 bytes. An I/O transfer of more than 8 bytes means multiple reads or writes of the same register. -.PP +.P This file is protected so that it can be read and written only by the user .IR root , or members of the group @@ -30,7 +30,7 @@ The driver is not auto-loaded. On modular kernels you might need to use the following command to load it explicitly before use: -.PP +.P .in +4n .EX $ modprobe msr diff --git a/man4/null.4 b/man4/null.4 index 409755997..b31c96ec5 100644 --- a/man4/null.4 +++ b/man4/null.4 @@ -13,7 +13,7 @@ Data written to the and .I /dev/zero special files is discarded. -.PP +.P Reads from .I /dev/null always return end of file (i.e., @@ -21,9 +21,9 @@ always return end of file (i.e., returns 0), whereas reads from .I /dev/zero always return bytes containing zero (\[aq]\e0\[aq] characters). -.PP +.P These devices are typically created by: -.PP +.P .in +4n .EX mknod \-m 666 /dev/null c 1 3 @@ -38,7 +38,7 @@ chown root:root /dev/null /dev/zero .SH NOTES If these devices are not writable and readable for all users, many programs will act strangely. -.PP +.P Since Linux 2.6.31, .\" commit 2b83868723d090078ac0e2120e06a1cc94dbaef0 reads from diff --git a/man4/pts.4 b/man4/pts.4 index a021f039f..3afff788e 100644 --- a/man4/pts.4 +++ b/man4/pts.4 @@ -15,7 +15,7 @@ The file is a character file with major number 5 and minor number 2, usually with mode 0666 and ownership root:root. It is used to create a pseudoterminal master and slave pair. -.PP +.P When a process opens .IR /dev/ptmx , it gets a file @@ -29,19 +29,19 @@ is an independent pseudoterminal master with its own associated slave, whose path can be found by passing the file descriptor to .BR ptsname (3). -.PP +.P Before opening the pseudoterminal slave, you must pass the master's file descriptor to .BR grantpt (3) and .BR unlockpt (3). -.PP +.P Once both the pseudoterminal master and slave are open, the slave provides processes with an interface that is identical to that of a real terminal. -.PP +.P Data written to the slave is presented on the master file descriptor as input. Data written to the master is presented to the slave as input. -.PP +.P In practice, pseudoterminals are used for implementing terminal emulators such as .BR xterm (1), @@ -52,7 +52,7 @@ programs such as .BR sshd (8), in which data read from the pseudoterminal master is sent across the network to a client program that is connected to a terminal or terminal emulator. -.PP +.P Pseudoterminals can also be used to send input to programs that normally refuse to read input from pipes (such as .BR su (1), diff --git a/man4/ram.4 b/man4/ram.4 index 47161c505..0f9bddc92 100644 --- a/man4/ram.4 +++ b/man4/ram.4 @@ -11,9 +11,9 @@ ram \- ram disk device The .I ram device is a block device to access the ram disk in raw mode. -.PP +.P It is typically created by: -.PP +.P .in +4n .EX mknod \-m 660 /dev/ram b 1 1 diff --git a/man4/random.4 b/man4/random.4 index 89a738b4f..1d463254d 100644 --- a/man4/random.4 +++ b/man4/random.4 @@ -15,7 +15,7 @@ random, urandom \- kernel random number source devices .SH SYNOPSIS .nf #include <linux/random.h> -.PP +.P .BI "int ioctl(" fd ", RND" request ", " param ");" .fi .SH DESCRIPTION @@ -28,27 +28,27 @@ has major device number 1 and minor device number 8. The file .I /dev/urandom has major device number 1 and minor device number 9. -.PP +.P The random number generator gathers environmental noise from device drivers and other sources into an entropy pool. The generator also keeps an estimate of the number of bits of noise in the entropy pool. From this entropy pool, random numbers are created. -.PP +.P Linux 3.17 and later provides the simpler and safer .BR getrandom (2) interface which requires no special files; see the .BR getrandom (2) manual page for details. -.PP +.P When read, the .I /dev/urandom device returns random bytes using a pseudorandom number generator seeded from the entropy pool. Reads from this device do not block (i.e., the CPU is not yielded), but can incur an appreciable delay when requesting large amounts of data. -.PP +.P When read during early boot time, .I /dev/urandom may return data prior to the entropy pool being initialized. @@ -57,7 +57,7 @@ may return data prior to the entropy pool being initialized. If this is of concern in your application, use .BR getrandom (2) or \fI/dev/random\fP instead. -.PP +.P The \fI/dev/random\fP device is a legacy interface which dates back to a time where the cryptographic primitives used in the implementation of \fI/dev/urandom\fP were not widely trusted. @@ -65,7 +65,7 @@ It will return random bytes only within the estimated number of bits of fresh noise in the entropy pool, blocking if necessary. \fI/dev/random\fP is suitable for applications that need high quality randomness, and can afford indeterminate delays. -.PP +.P When the entropy pool is empty, reads from \fI/dev/random\fP will block until additional environmental noise is gathered. Since Linux 5.6, the @@ -89,7 +89,7 @@ will return \-1 and .I errno will be set to .BR EAGAIN . -.PP +.P The .B O_NONBLOCK flag has no effect when opening @@ -104,7 +104,7 @@ Reads with a buffer over this limit may return less than the requested number of bytes or fail with the error .BR EINTR , if interrupted by a signal handler. -.PP +.P Since Linux 3.16, .\" commit 79a8468747c5f95ed3d5ce8376a3e82e0c5857fc a @@ -119,7 +119,7 @@ from will return at most 512 bytes .\" SEC_XFER_SIZE in drivers/char/random.c (340 bytes before Linux 2.6.12). -.PP +.P Writing to \fI/dev/random\fP or \fI/dev/urandom\fP will update the entropy pool with the data written, but this will not result in a higher entropy count. @@ -137,7 +137,7 @@ these applications, .BR getrandom (2) must be used instead, because it will block until the entropy pool is initialized. -.PP +.P If a seed file is saved across reboots as recommended below, the output is cryptographically secure against attackers without local root access as @@ -156,7 +156,7 @@ entropy is not immediately available. If your system does not have \fI/dev/random\fP and \fI/dev/urandom\fP created already, they can be created with the following commands: -.PP +.P .in +4n .EX mknod \-m 666 /dev/random c 1 8 @@ -164,7 +164,7 @@ mknod \-m 666 /dev/urandom c 1 9 chown root:root /dev/random /dev/urandom .EE .in -.PP +.P When a Linux system starts up without much operator interaction, the entropy pool may be in a fairly predictable state. This reduces the actual amount of noise in the entropy pool @@ -173,7 +173,7 @@ In order to counteract this effect, it helps to carry entropy pool information across shut-downs and start-ups. To do this, add the lines to an appropriate script which is run during the Linux system start-up sequence: -.PP +.P .in +4n .EX echo "Initializing random number generator..." @@ -192,10 +192,10 @@ bytes=$(expr $bits / 8) dd if=/dev/urandom of=$random_seed count=1 bs=$bytes .EE .in -.PP +.P Also, add the following lines in an appropriate script which is run during the Linux system shutdown: -.PP +.P .in +4n .EX # Carry a random seed from shut\-down to start\-up @@ -210,7 +210,7 @@ bytes=$(expr $bits / 8) dd if=/dev/urandom of=$random_seed count=1 bs=$bytes .EE .in -.PP +.P In the above examples, we assume Linux 2.6.0 or later, where .I /proc/sys/kernel/random/poolsize returns the size of the entropy pool in bits (see below). @@ -345,5 +345,5 @@ may return data prior to the entropy pool being initialized. .BR mknod (1), .BR getrandom (2), .BR random (7) -.PP +.P RFC\ 1750, "Randomness Recommendations for Security" diff --git a/man4/rtc.4 b/man4/rtc.4 index ecd12fd54..9619ff23c 100644 --- a/man4/rtc.4 +++ b/man4/rtc.4 @@ -14,24 +14,24 @@ rtc \- real-time clock .SH SYNOPSIS .nf #include <linux/rtc.h> -.PP +.P .BI "int ioctl(" fd ", RTC_" request ", " param ");" .fi .SH DESCRIPTION This is the interface to drivers for real-time clocks (RTCs). -.PP +.P Most computers have one or more hardware clocks which record the current "wall clock" time. These are called "Real Time Clocks" (RTCs). One of these usually has battery backup power so that it tracks the time even while the computer is turned off. RTCs often provide alarms and other interrupts. -.PP +.P All i386 PCs, and ACPI-based systems, have an RTC that is compatible with the Motorola MC146818 chip on the original PC/AT. Today such an RTC is usually integrated into the mainboard's chipset (south bridge), and uses a replaceable coin-sized backup battery. -.PP +.P Non-PC systems, such as embedded systems built around system-on-chip processors, use other implementations. They usually won't offer the same functionality as the RTC from a PC/AT. @@ -47,7 +47,7 @@ defined to be the POSIX Epoch: 1970-01-01 00:00:00 +0000 (UTC). (One common implementation counts timer interrupts, once per "jiffy", at a frequency of 100, 250, or 1000 Hz.) That is, it is supposed to report wall clock time, which RTCs also do. -.PP +.P A key difference between an RTC and the system clock is that RTCs run even when the system is in a low power state (including "off"), and the system clock can't. @@ -63,7 +63,7 @@ RTCs can be read and written with or directly with the .BR ioctl (2) requests listed below. -.PP +.P Besides tracking the date and time, many RTCs can also generate interrupts .IP \[bu] 3 @@ -73,7 +73,7 @@ at periodic intervals with a frequency that can be set to any power-of-2 multiple in the range 2 Hz to 8192 Hz; .IP \[bu] on reaching a previously specified alarm time. -.PP +.P Each of those interrupt sources can be enabled or disabled separately. On many systems, the alarm interrupt can be configured as a system wakeup event, which can resume the system from a low power state such as @@ -82,7 +82,7 @@ Hibernation (called S4 in ACPI systems), or even "off" (called S5 in ACPI systems). On some systems, the battery backed RTC can't issue interrupts, but another one can. -.PP +.P The .I /dev/rtc (or @@ -249,7 +249,7 @@ capability). .B RTC_WKALM_SET Some RTCs support a more powerful alarm interface, using these ioctls to read or write the RTC's alarm time (respectively) with this structure: -.PP +.P .RS .in +4n .EX @@ -310,21 +310,21 @@ reference using it will update a designated RTC periodically every 11 minutes. To do so, the kernel has to briefly turn off periodic interrupts; this might affect programs using that RTC. -.PP +.P An RTC's Epoch has nothing to do with the POSIX Epoch which is used only for the system clock. -.PP +.P If the year according to the RTC's Epoch and the year register is less than 1970 it is assumed to be 100 years later, that is, between 2000 and 2069. -.PP +.P Some RTCs support "wildcard" values in alarm fields, to support scenarios like periodic alarms at fifteen minutes after every hour, or on the first day of each month. Such usage is nonportable; portable user-space code expects only a single alarm interrupt, and will either disable or reinitialize the alarm after receiving it. -.PP +.P Some RTCs support periodic interrupts with periods that are multiples of a second rather than fractions of a second; multiple alarms; @@ -342,6 +342,6 @@ capabilities that are not currently exposed by this API. .BR gmtime (3), .BR time (7), .BR hwclock (8) -.PP +.P .I Documentation/rtc.txt in the Linux kernel source tree @@ -22,7 +22,7 @@ is a number denoting the partition on that physical drive. Often, the partition number, .IR p , will be left off when the device corresponds to the whole drive. -.PP +.P SCSI disks have a major device number of 8, and a minor device number of the form (16 * .IR drive_number ") + " partition_number , @@ -37,7 +37,7 @@ partition 0 is the whole drive partitions 1\[en]4 are the DOS "primary" partitions .IP \[bu] partitions 5\[en]8 are the DOS "extended" (or "logical") partitions -.PP +.P For example, .I /dev/sda will have major 8, minor 0, and will refer to all of the first SCSI drive @@ -45,7 +45,7 @@ in the system; and .I /dev/sdb3 will have major 8, minor 19, and will refer to the third DOS "primary" partition on the second SCSI drive in the system. -.PP +.P At this time, only block devices are provided. Raw devices have not yet been implemented. .SH DESCRIPTION @@ -55,7 +55,7 @@ are provided: .TP .B HDIO_GETGEO Returns the BIOS disk parameters in the following structure: -.PP +.P .in +4n .EX struct hd_geometry { diff --git a/man4/sk98lin.4 b/man4/sk98lin.4 index 4d223a279..3bbbd69f0 100644 --- a/man4/sk98lin.4 +++ b/man4/sk98lin.4 @@ -46,27 +46,27 @@ sk98lin \- Marvell/SysKonnect Gigabit Ethernet driver v6.21 .hy 0 .BR Note : This obsolete driver was removed in Linux 2.6.26. -.PP +.P .B sk98lin is the Gigabit Ethernet driver for Marvell and SysKonnect network adapter cards. It supports SysKonnect SK-98xx/SK-95xx compliant Gigabit Ethernet Adapter and any Yukon compliant chipset. -.PP +.P When loading the driver using insmod, parameters for the network adapter cards might be stated as a sequence of comma separated commands. If for instance two network adapters are installed and AutoNegotiation on Port A of the first adapter should be ON, but on the Port A of the second adapter switched OFF, one must enter: -.PP +.P .in +4n .EX insmod sk98lin.o AutoNeg_A=On,Off .EE .in -.PP +.P After .B sk98lin is bound to one or more adapter cards and the @@ -81,7 +81,7 @@ where .I x is the number of the interface that has been assigned to a dedicated port by the system. -.PP +.P If loading is finished, any desired IP address can be assigned to the respective .I eth[x] @@ -91,7 +91,7 @@ command. This causes the adapter to connect to the Ethernet and to display a status message on the console saying "ethx: network connection up using port y" followed by the configured or detected connection parameters. -.PP +.P The .B sk98lin also supports large frames (also called jumbo frames). @@ -107,22 +107,22 @@ command with the mtu parameter. If for instance eth0 needs an IP address and a large frame MTU size, the following two commands might be used: -.PP +.P .in +4n .EX ifconfig eth0 10.1.1.1 ifconfig eth0 mtu 9000 .EE .in -.PP +.P Those two commands might even be combined into one: -.PP +.P .in +4n .EX ifconfig eth0 10.1.1.1 mtu 9000 .EE .in -.PP +.P Note that large frames can be used only if permitted by your network infrastructure. This means, that any switch being used in your Ethernet must @@ -135,23 +135,23 @@ In addition to the switches inside the network, all network adapters that are to be used must also be enabled regarding jumbo frames. If an adapter is not set to receive large frames, it will simply drop them. -.PP +.P Switching back to the standard Ethernet frame size can be done by using the .BR ifconfig (8) command again: -.PP +.P .in +4n .EX ifconfig eth0 mtu 1500 .EE .in -.PP +.P The Marvell/SysKonnect Gigabit Ethernet driver for Linux is able to support VLAN and Link Aggregation according to IEEE standards 802.1, 802.1q, and 802.3ad. Those features are available only after installation of open source modules which can be found on the Internet: -.PP +.P .IR VLAN : .UR http://www.candelatech.com\:/\[ti]greear\:/vlan.html .UE @@ -160,7 +160,7 @@ which can be found on the Internet: .IR Aggregation : .UR http://www.st.rim.or.jp\:/\[ti]yumo .UE -.PP +.P Note that Marvell/SysKonnect does not offer any support for these open source modules and does not take the responsibility for any kind of failures or problems arising when using these modules. diff --git a/man4/smartpqi.4 b/man4/smartpqi.4 index ab7a5a3a4..0da664131 100644 --- a/man4/smartpqi.4 +++ b/man4/smartpqi.4 @@ -491,6 +491,6 @@ was replaced by two sysfs entries: .BR sd (4), .BR st (4), .BR sg (4) -.PP +.P .I Documentation/ABI/testing/sysfs\-bus\-pci\-devices\-cciss in the Linux kernel source tree. @@ -8,7 +8,7 @@ st \- SCSI tape device .SH SYNOPSIS .nf .B #include <sys/mtio.h> -.PP +.P .BI "int ioctl(int " fd ", int " request " [, (void *)" arg3 "]);" .BI "int ioctl(int " fd ", MTIOCTOP, (struct mtop *)" mt_cmd ); .BI "int ioctl(int " fd ", MTIOCGET, (struct mtget *)" mt_status ); @@ -23,7 +23,7 @@ Currently, the driver takes control of all detected devices of type The .B st driver uses major device number 9. -.PP +.P Each device uses eight minor device numbers. The lowermost five bits in the minor numbers are assigned sequentially in the order of @@ -43,7 +43,7 @@ Devices opened using the \[lq]no-rewind\[rq] device number will not. for instance, mt does not lead to the desired result: the tape is rewound after the mt command and the next command starts from the beginning of the tape). -.PP +.P Within each group, four minor numbers are available to define devices with different characteristics (block size, compression, density, etc.) @@ -57,9 +57,9 @@ drive. The default allocation allows control of 32 tape drives. For instance, it is possible to control up to 64 tape drives with two minor numbers for different options.) -.PP +.P Devices are typically created by: -.PP +.P .in +4n .EX mknod \-m 666 /dev/st0 c 9 0 @@ -72,9 +72,9 @@ mknod \-m 666 /dev/nst0m c 9 192 mknod \-m 666 /dev/nst0a c 9 224 .EE .in -.PP +.P There is no corresponding block device. -.PP +.P The driver uses an internal buffer that has to be large enough to hold at least one tape block. Before Linux 2.1.121, the buffer is @@ -89,7 +89,7 @@ By default, the maximum number of parts is 16. This means that the maximum block size is very large (2\ MB if allocation of 16 blocks of 128\ kB succeeds). -.PP +.P The driver's internal buffer size is determined by a compile-time constant which can be overridden with a kernel startup option. In addition to this, the driver tries to allocate a larger temporary @@ -98,7 +98,7 @@ However, run-time allocation of large contiguous blocks of memory may fail and it is advisable not to rely too much on dynamic buffer allocation before Linux 2.1.121 (this applies also to demand-loading the driver with kerneld or kmod). -.PP +.P The driver does not specifically support any tape drive brand or model. After system start-up the tape device options are defined by @@ -111,7 +111,7 @@ be changed with explicit calls and remain in effect when the device is closed and reopened. Setting the options affects both the auto-rewind and the nonrewind device. -.PP +.P Different options can be specified for the different devices within the subgroup of four. The options take effect when the device is @@ -120,7 +120,7 @@ For example, the system administrator can define one device that writes in fixed-block mode with a certain block size, and one which writes in variable-block mode (if the drive supports both modes). -.PP +.P The driver supports .B tape partitions if they are supported by the drive. @@ -143,12 +143,12 @@ compile-time constant (originally four). The driver contains an .BR ioctl (2) that can format a tape with either one or two partitions. -.PP +.P Device .I /dev/tape is usually created as a hard or soft link to the default tape device on the system. -.PP +.P Starting from Linux 2.6.2, the driver exports in the sysfs directory .I /sys/class/scsi_tape the attached devices and some parameters assigned to the devices. @@ -165,7 +165,7 @@ Note that the blocks on the tape don't contain any information about the writing mode: when reading, the only important thing is to use commands that accept the block sizes on the tape. -.PP +.P In variable-block mode the read byte count does not have to match the tape block size exactly. If the byte count is larger than the @@ -173,7 +173,7 @@ next block on tape, the driver returns the data and the function returns the actual block size. If the block size is larger than the byte count, an error is returned. -.PP +.P In fixed-block mode the read byte counts can be arbitrary if buffering is enabled, or a multiple of the tape block size if buffering is disabled. @@ -182,7 +182,7 @@ arbitrary byte count if buffering is enabled. In all other cases (before Linux 2.1.121 with buffering disabled or newer kernel) the write byte count must be a multiple of the tape block size. -.PP +.P In Linux 2.6, the driver tries to use direct transfers between the user buffer and the device. If this is not possible, the driver's internal buffer @@ -191,10 +191,10 @@ The reasons for not using direct transfers include improper alignment of the user buffer (default is 512 bytes but this can be changed by the HBA driver), one or more pages of the user buffer not reachable by the SCSI adapter, and so on. -.PP +.P A filemark is automatically written to tape if the last tape operation before close was a write. -.PP +.P When a filemark is encountered while reading, the following happens. If there are data remaining in the buffer when the filemark @@ -224,7 +224,7 @@ Not all drives support all operations. The driver returns an .B EIO error if the drive rejects an operation. -.PP +.P .in +4n .EX /* Structure for MTIOCTOP \- mag tape op command: */ @@ -234,7 +234,7 @@ struct mtop { }; .EE .in -.PP +.P Magnetic tape operations for normal tape use: .TP .B MTBSF @@ -395,7 +395,7 @@ filemarks. Write .I mt_count setmarks. -.PP +.P Magnetic tape operations for setting of device options (by the superuser): .TP .B MTSETDRVBUFFER @@ -609,9 +609,9 @@ In BSD semantics the tape position is not changed. .BR MT_NO_WAIT " (Default: false)" Enables immediate mode (i.e., don't wait for the command to finish) for some commands (e.g., rewind). -.PP +.P An example: -.PP +.P .in +4n .EX struct mtop mt_cmd; @@ -621,14 +621,14 @@ mt_cmd.mt_count = MT_ST_BOOLEANS | ioctl(fd, MTIOCTOP, mt_cmd); .EE .in -.PP +.P The default block size for a device can be set with .B MT_ST_DEF_BLKSIZE and the default density code can be set with .BR MT_ST_DEFDENSITY . The values for the parameters are or'ed with the operation code. -.PP +.P With Linux 2.1.x and later, the timeout values can be set with the subcommand .B MT_ST_SET_TIMEOUT @@ -645,7 +645,7 @@ These commands can be used to set more practical values for a specific drive. The timeouts set for one device apply for all devices linked to the same drive. -.PP +.P Starting from Linux 2.4.19 and Linux 2.5.43, the driver supports a status bit which indicates whether the drive requests cleaning. The method used by the @@ -670,7 +670,7 @@ the masked sense data byte. .SS MTIOCGET \[em] get status This request takes an argument of type .IR "(struct mtget\ *)" . -.PP +.P .in +4n .EX /* structure for MTIOCGET \- mag tape get status command */ @@ -812,7 +812,7 @@ This drive must be a SCSI-2 drive that supports the command (device-specific address) or a Tandberg-compatible SCSI-1 drive (Tandberg, Archive Viper, Wangtek, ... ). -.PP +.P .in +4n .EX /* structure for MTIOCPOS \- mag tape get position command */ @@ -940,7 +940,7 @@ telling it to use larger blocks). If this is not possible, direct transfers can be disabled. .SH SEE ALSO .BR mt (1) -.PP +.P The file .I drivers/scsi/README.st or diff --git a/man4/tty.4 b/man4/tty.4 index 139886844..7a0d214b6 100644 --- a/man4/tty.4 +++ b/man4/tty.4 @@ -15,7 +15,7 @@ The file is a character file with major number 5 and minor number 0, usually with mode 0666 and ownership root:tty. It is a synonym for the controlling terminal of a process, if any. -.PP +.P In addition to the .BR ioctl (2) requests supported by the device that @@ -27,7 +27,7 @@ request is supported. .SS TIOCNOTTY Detach the calling process from its controlling terminal. -.PP +.P If the process is the session leader, then .B SIGHUP @@ -35,7 +35,7 @@ and .B SIGCONT signals are sent to the foreground process group and all processes in the current session lose their controlling tty. -.PP +.P This .BR ioctl (2) call works only on file descriptors connected diff --git a/man4/ttyS.4 b/man4/ttyS.4 index e5e47a66b..dcab5ca4a 100644 --- a/man4/ttyS.4 +++ b/man4/ttyS.4 @@ -10,9 +10,9 @@ ttyS \- serial terminal lines .SH DESCRIPTION .B ttyS[0\-3] are character devices for the serial terminal lines. -.PP +.P They are typically created by: -.PP +.P .in +4n .EX mknod \-m 660 /dev/ttyS0 c 4 64 # base address 0x3f8 diff --git a/man4/vcs.4 b/man4/vcs.4 index 66f06ab11..fe159f093 100644 --- a/man4/vcs.4 +++ b/man4/vcs.4 @@ -16,7 +16,7 @@ is a character device with major number 7 and minor number 0, usually with mode 0644 and ownership root:tty. It refers to the memory of the currently displayed virtual console terminal. -.PP +.P .I /dev/vcs[1\-63] are character devices for virtual console terminals, they have major number 7 and minor number 1 to 63, usually @@ -36,7 +36,7 @@ dimensions and cursor position: = .I y = 0 at the top left corner of the screen.) -.PP +.P When a 512-character font is loaded, the 9th bit position can be fetched by applying the .BR ioctl (2) @@ -50,16 +50,16 @@ the value is returned in the pointed to by the third .BR ioctl (2) argument. -.PP +.P These devices replace the screendump .BR ioctl (2) operations of .BR ioctl_console (2), so the system administrator can control access using filesystem permissions. -.PP +.P The devices for the first eight virtual consoles may be created by: -.PP +.P .in +4n .EX for x in 0 1 2 3 4 5 6 7 8; do @@ -69,7 +69,7 @@ done chown root:tty /dev/vcs* .EE .in -.PP +.P No .BR ioctl (2) requests are supported. @@ -83,39 +83,39 @@ requests are supported. Introduced with Linux 1.1.92. .SH EXAMPLES You may do a screendump on vt3 by switching to vt1 and typing -.PP +.P .in +4n .EX cat /dev/vcs3 >foo .EE .in -.PP +.P Note that the output does not contain newline characters, so some processing may be required, like in -.PP +.P .in +4n .EX fold \-w 81 /dev/vcs3 | lpr .EE .in -.PP +.P or (horrors) -.PP +.P .in +4n .EX setterm \-dump 3 \-file /proc/self/fd/1 .EE .in -.PP +.P The .I /dev/vcsa0 device is used for Braille support. -.PP +.P This program displays the character and screen attributes under the cursor of the second virtual console, then changes the background color there: -.PP +.P .EX #include <unistd.h> #include <stdlib.h> diff --git a/man4/veth.4 b/man4/veth.4 index 1d1c355a5..690a2087e 100644 --- a/man4/veth.4 +++ b/man4/veth.4 @@ -15,27 +15,27 @@ devices are virtual Ethernet devices. They can act as tunnels between network namespaces to create a bridge to a physical network device in another namespace, but can also be used as standalone network devices. -.PP +.P .B veth devices are always created in interconnected pairs. A pair can be created using the command: -.PP +.P .in +4n .EX # ip link add <p1-name> type veth peer name <p2-name> .EE .in -.PP +.P In the above, .I p1-name and .I p2-name are the names assigned to the two connected end points. -.PP +.P Packets transmitted on one device in the pair are immediately received on the other device. When either device is down, the link state of the pair is down. -.PP +.P .B veth device pairs are useful for combining the network facilities of the kernel together in interesting ways. @@ -46,28 +46,28 @@ thus allowing communication between network namespaces. To do this, one can provide the .B netns parameter when creating the interfaces: -.PP +.P .in +4n .EX # ip link add <p1\-name> netns <p1\-ns> type veth peer <p2\-name> netns <p2\-ns> .EE .in -.PP +.P or, for an existing .B veth pair, move one side to the other namespace: -.PP +.P .in +4n .EX # ip link set <p2\-name> netns <p2\-ns> .EE .in -.PP +.P .BR ethtool (8) can be used to find the peer of a .B veth network interface, using commands something like: -.PP +.P .in +4n .EX # \fBip link add ve_A type veth peer name ve_B\fP # Create veth pair diff --git a/man4/wavelan.4 b/man4/wavelan.4 index a54144034..ad2532cbc 100644 --- a/man4/wavelan.4 +++ b/man4/wavelan.4 @@ -18,7 +18,7 @@ wavelan \- AT&T GIS WaveLAN ISA device driver .SH DESCRIPTION .I This driver is obsolete: it was removed in Linux 2.6.35. -.PP +.P .B wavelan is the low-level device driver for the NCR / AT&T / Lucent .B WaveLAN ISA @@ -120,7 +120,7 @@ This driver fails to detect some Wavelan cards. If this happens for you, you must look in the source code on how to add your card to the detection routine. -.PP +.P Some of the mentioned features are optional. You may enable or disable them by changing flags in the driver header and recompile. |