1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # This file is distributed under the same license as the PACKAGE package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: PACKAGE VERSION\n"
10 "POT-Creation-Date: 2013-09-28 04:06+0900\n"
11 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
19 #. Copyright (C) 2011, Hewlett-Packard Development Company, L.P.
20 #. Written by Stephen M. Cameron <scameron@beardog.cce.hp.com>
22 #. %%%LICENSE_START(GPLv2_ONELINE)
23 #. Licensed under GNU General Public License version 2 (GPLv2)
26 #. shorthand for double quote that works everywhere.
28 #: build/C/man4/cciss.4:9 build/C/man4/hpsa.4:9
34 #: build/C/man4/cciss.4:10
40 #: build/C/man4/cciss.4:10 build/C/man4/console_codes.4:23 build/C/man4/dsp56k.4:27 build/C/man4/hpsa.4:10 build/C/man4/sk98lin.4:27
46 #: build/C/man4/cciss.4:10 build/C/man4/console.4:12 build/C/man4/console_codes.4:23 build/C/man4/console_ioctl.4:40 build/C/man5/core.5:25 build/C/man4/cpuid.4:26 build/C/man4/dsp56k.4:27 build/C/man4/fd.4:28 build/C/man7/fifo.7:13 build/C/man4/full.4:26 build/C/man3/gnu_get_libc_version.3:26 build/C/man4/hd.4:29 build/C/man4/hpsa.4:10 build/C/man4/initrd.4:35 build/C/man4/lp.4:27 build/C/man3/makedev.3:26 build/C/man4/mem.4:26 build/C/man2/mknod.2:14 build/C/man4/mouse.4:26 build/C/man4/msr.4:26 build/C/man4/null.4:26 build/C/man7/pipe.7:25 build/C/man4/ram.4:26 build/C/man4/random.4:19 build/C/man4/sd.4:26 build/C/man4/sk98lin.4:27 build/C/man4/st.4:25 build/C/man2/syslog.2:31 build/C/man3/syslog.3:36 build/C/man4/ttyS.4:26 build/C/man7/uri.7:48 build/C/man4/vcs.4:29 build/C/man4/wavelan.4:15
52 #: build/C/man4/cciss.4:10 build/C/man4/console.4:12 build/C/man4/console_codes.4:23 build/C/man4/console_ioctl.4:40 build/C/man5/core.5:25 build/C/man4/cpuid.4:26 build/C/man4/dsp56k.4:27 build/C/man4/fd.4:28 build/C/man7/fifo.7:13 build/C/man4/full.4:26 build/C/man3/gnu_get_libc_version.3:26 build/C/man4/hd.4:29 build/C/man4/hpsa.4:10 build/C/man4/initrd.4:35 build/C/man4/lp.4:27 build/C/man3/makedev.3:26 build/C/man4/mem.4:26 build/C/man3/mkfifo.3:27 build/C/man2/mknod.2:14 build/C/man4/mouse.4:26 build/C/man4/msr.4:26 build/C/man4/null.4:26 build/C/man7/pipe.7:25 build/C/man4/ram.4:26 build/C/man4/random.4:19 build/C/man4/sd.4:26 build/C/man3/setlogmask.3:25 build/C/man4/sk98lin.4:27 build/C/man4/st.4:25 build/C/man3/stdarg.3:43 build/C/man2/syslog.2:31 build/C/man3/syslog.3:36 build/C/man4/ttyS.4:26 build/C/man7/uri.7:48 build/C/man4/vcs.4:29 build/C/man4/wavelan.4:15
54 msgid "Linux Programmer's Manual"
58 #: build/C/man4/cciss.4:11 build/C/man4/console.4:13 build/C/man4/console_codes.4:24 build/C/man4/console_ioctl.4:41 build/C/man5/core.5:26 build/C/man4/cpuid.4:27 build/C/man4/dsp56k.4:28 build/C/man4/fd.4:29 build/C/man7/fifo.7:14 build/C/man4/full.4:27 build/C/man3/gnu_get_libc_version.3:27 build/C/man4/hd.4:30 build/C/man4/hpsa.4:11 build/C/man4/initrd.4:36 build/C/man4/lp.4:28 build/C/man3/makedev.3:27 build/C/man4/mem.4:27 build/C/man3/mkfifo.3:28 build/C/man2/mknod.2:15 build/C/man4/mouse.4:27 build/C/man4/msr.4:27 build/C/man4/null.4:27 build/C/man7/pipe.7:26 build/C/man4/ram.4:27 build/C/man4/random.4:20 build/C/man4/sd.4:27 build/C/man3/setlogmask.3:26 build/C/man4/sk98lin.4:28 build/C/man4/st.4:26 build/C/man3/stdarg.3:44 build/C/man2/syslog.2:32 build/C/man3/syslog.3:37 build/C/man4/ttyS.4:27 build/C/man7/uri.7:49 build/C/man4/vcs.4:30 build/C/man4/wavelan.4:16
64 #: build/C/man4/cciss.4:13
65 msgid "cciss - HP Smart Array block driver"
69 #: build/C/man4/cciss.4:13 build/C/man4/dsp56k.4:30 build/C/man3/gnu_get_libc_version.3:29 build/C/man4/hpsa.4:13 build/C/man4/lp.4:30 build/C/man3/makedev.3:29 build/C/man3/mkfifo.3:30 build/C/man2/mknod.2:17 build/C/man4/random.4:22 build/C/man4/sd.4:29 build/C/man3/setlogmask.3:28 build/C/man4/sk98lin.4:30 build/C/man4/st.4:28 build/C/man3/stdarg.3:46 build/C/man2/syslog.2:35 build/C/man3/syslog.3:39 build/C/man7/uri.7:51 build/C/man4/wavelan.4:18
75 #: build/C/man4/cciss.4:16
77 msgid "modprobe cciss [ cciss_allow_hpsa=1 ]\n"
81 #: build/C/man4/cciss.4:17 build/C/man4/console.4:15 build/C/man4/console_codes.4:26 build/C/man4/console_ioctl.4:43 build/C/man5/core.5:28 build/C/man4/cpuid.4:29 build/C/man4/dsp56k.4:46 build/C/man4/fd.4:131 build/C/man7/fifo.7:16 build/C/man4/full.4:39 build/C/man3/gnu_get_libc_version.3:36 build/C/man4/hd.4:32 build/C/man4/hpsa.4:17 build/C/man4/initrd.4:71 build/C/man4/lp.4:43 build/C/man3/makedev.3:39 build/C/man4/mem.4:29 build/C/man3/mkfifo.3:37 build/C/man2/mknod.2:39 build/C/man4/mouse.4:33 build/C/man4/msr.4:29 build/C/man4/null.4:29 build/C/man7/pipe.7:28 build/C/man4/ram.4:29 build/C/man4/random.4:26 build/C/man4/sd.4:71 build/C/man3/setlogmask.3:34 build/C/man4/sk98lin.4:62 build/C/man4/st.4:37 build/C/man3/stdarg.3:56 build/C/man2/syslog.2:46 build/C/man3/syslog.3:59 build/C/man4/ttyS.4:29 build/C/man7/uri.7:71 build/C/man4/vcs.4:32 build/C/man4/wavelan.4:20
87 #: build/C/man4/cciss.4:20
88 msgid "B<cciss> is a block driver for older HP Smart Array RAID controllers."
92 #: build/C/man4/cciss.4:20 build/C/man4/hpsa.4:20 build/C/man4/initrd.4:180
98 #: build/C/man4/cciss.4:29
100 "I<cciss_allow_hpsa=1>: This option prevents the B<cciss> driver from "
101 "attempting to drive any controllers that the B<hpsa>(4) driver is capable "
102 "of controlling, which is to say, the B<cciss> driver is restricted by this "
103 "option to the following controllers:"
107 #: build/C/man4/cciss.4:48
110 " Smart Array 5300\n"
113 " Smart Array 5312\n"
116 " Smart Array 6400\n"
117 " Smart Array 6400 EM\n"
119 " Smart Array P600\n"
120 " Smart Array P400i\n"
121 " Smart Array E200i\n"
122 " Smart Array E200\n"
123 " Smart Array E200i\n"
124 " Smart Array E200i\n"
125 " Smart Array E200i\n"
126 " Smart Array E500\n"
130 #: build/C/man4/cciss.4:49 build/C/man4/hpsa.4:39
132 msgid "Supported hardware"
136 #: build/C/man4/cciss.4:53
137 msgid "The B<cciss> driver supports the following Smart Array boards:"
141 #: build/C/man4/cciss.4:79
144 " Smart Array 5300\n"
147 " Smart Array 5312\n"
150 " Smart Array 6400\n"
151 " Smart Array 6400 U320 Expansion Module\n"
153 " Smart Array P600\n"
154 " Smart Array P800\n"
155 " Smart Array E400\n"
156 " Smart Array P400i\n"
157 " Smart Array E200\n"
158 " Smart Array E200i\n"
159 " Smart Array E500\n"
160 " Smart Array P700m\n"
161 " Smart Array P212\n"
162 " Smart Array P410\n"
163 " Smart Array P410i\n"
164 " Smart Array P411\n"
165 " Smart Array P812\n"
166 " Smart Array P712m\n"
167 " Smart Array P711m\n"
171 #: build/C/man4/cciss.4:80 build/C/man4/hpsa.4:55
173 msgid "Configuration details"
177 #: build/C/man4/cciss.4:89 build/C/man4/hpsa.4:63
179 "To configure HP Smart Array controllers, use the HP Array Configuration "
180 "Utility (either B<hpacuxe>(8) or B<hpacucli>(8)) or the Offline ROM-based "
181 "Configuration Utility (ORCA) run from the Smart Array's option ROM at boot "
186 #: build/C/man4/cciss.4:89 build/C/man4/console.4:91 build/C/man4/dsp56k.4:110 build/C/man4/fd.4:194 build/C/man4/full.4:59 build/C/man4/hd.4:103 build/C/man4/hpsa.4:63 build/C/man4/initrd.4:418 build/C/man4/lp.4:126 build/C/man4/mem.4:78 build/C/man4/mouse.4:180 build/C/man4/null.4:57 build/C/man4/ram.4:41 build/C/man4/random.4:275 build/C/man4/sd.4:131 build/C/man4/sk98lin.4:587 build/C/man4/st.4:879 build/C/man4/ttyS.4:46 build/C/man4/vcs.4:93
192 #: build/C/man4/cciss.4:90 build/C/man4/hpsa.4:64
198 #: build/C/man4/cciss.4:92
199 msgid "The device naming scheme is as follows:"
203 #: build/C/man4/cciss.4:95
205 msgid "Major numbers:\n"
209 #: build/C/man4/cciss.4:104
223 #: build/C/man4/cciss.4:106
225 msgid "Minor numbers:\n"
229 #: build/C/man4/cciss.4:113
232 " b7 b6 b5 b4 b3 b2 b1 b0\n"
233 " |----+----| |----+----|\n"
235 " | +-------- Partition ID (0=wholedev, 1-15 partition)\n"
237 " +-------------------- Logical Volume number\n"
241 #: build/C/man4/cciss.4:115
243 msgid "The device naming scheme is:\n"
247 #: build/C/man4/cciss.4:120
250 " /dev/cciss/c0d0 Controller 0, disk 0, whole device\n"
251 " /dev/cciss/c0d0p1 Controller 0, disk 0, partition 1\n"
252 " /dev/cciss/c0d0p2 Controller 0, disk 0, partition 2\n"
253 " /dev/cciss/c0d0p3 Controller 0, disk 0, partition 3\n"
257 #: build/C/man4/cciss.4:125
260 " /dev/cciss/c1d1 Controller 1, disk 1, whole device\n"
261 " /dev/cciss/c1d1p1 Controller 1, disk 1, partition 1\n"
262 " /dev/cciss/c1d1p2 Controller 1, disk 1, partition 2\n"
263 " /dev/cciss/c1d1p3 Controller 1, disk 1, partition 3\n"
267 #: build/C/man4/cciss.4:126
269 msgid "Files in /proc"
273 #: build/C/man4/cciss.4:132
275 "The files I</proc/driver/cciss/cciss[0-9]+> contain information about the "
276 "configuration of each controller. For example:"
280 #: build/C/man4/cciss.4:152
283 " $ B<cd /proc/driver/cciss>\n"
286 " -rw-r--r-- 1 root root 0 2010-09-10 10:38 cciss0\n"
287 " -rw-r--r-- 1 root root 0 2010-09-10 10:38 cciss1\n"
288 " -rw-r--r-- 1 root root 0 2010-09-10 10:38 cciss2\n"
290 " cciss2: HP Smart Array P800 Controller\n"
291 " Board ID: 0x3223103c\n"
292 " Firmware Version: 7.14\n"
294 " Logical drives: 1\n"
295 " Current Q depth: 0\n"
296 " Current # commands on controller: 0\n"
297 " Max Q depth since init: 1\n"
298 " Max # commands on controller since init: 2\n"
299 " Max SG entries since init: 32\n"
300 " Sequential access devices: 0\n"
304 #: build/C/man4/cciss.4:154
306 msgid " cciss/c2d0: 36.38GB RAID 0\n"
310 #: build/C/man4/cciss.4:155
312 msgid "Files in /sys"
316 #: build/C/man4/cciss.4:156
318 msgid "I</sys/bus/pci/devices/E<lt>devE<gt>/ccissX/cXdY/model>"
322 #: build/C/man4/cciss.4:162
324 "Displays the SCSI INQUIRY page 0 model for logical drive I<Y> of controller "
329 #: build/C/man4/cciss.4:162
331 msgid "I</sys/bus/pci/devices/E<lt>devE<gt>/ccissX/cXdY/rev>"
335 #: build/C/man4/cciss.4:168
337 "Displays the SCSI INQUIRY page 0 revision for logical drive I<Y> of "
342 #: build/C/man4/cciss.4:168
344 msgid "I</sys/bus/pci/devices/E<lt>devE<gt>/ccissX/cXdY/unique_id>"
348 #: build/C/man4/cciss.4:174
350 "Displays the SCSI INQUIRY page 83 serial number for logical drive I<Y> of "
355 #: build/C/man4/cciss.4:174
357 msgid "I</sys/bus/pci/devices/E<lt>devE<gt>/ccissX/cXdY/vendor>"
361 #: build/C/man4/cciss.4:180
363 "Displays the SCSI INQUIRY page 0 vendor for logical drive I<Y> of controller "
368 #: build/C/man4/cciss.4:180
370 msgid "I</sys/bus/pci/devices/E<lt>devE<gt>/ccissX/cXdY/block:cciss!cXdY>"
374 #: build/C/man4/cciss.4:184
375 msgid "A symbolic link to I</sys/block/cciss!cXdY>."
379 #: build/C/man4/cciss.4:184
381 msgid "I</sys/bus/pci/devices/E<lt>devE<gt>/ccissX/rescan>"
385 #: build/C/man4/cciss.4:188
387 "When this file is written to, the driver rescans the controller to discover "
388 "any new, removed, or modified logical drives."
392 #: build/C/man4/cciss.4:188
394 msgid "I</sys/bus/pci/devices/E<lt>devE<gt>/ccissX/resettable>"
398 #: build/C/man4/cciss.4:197
400 "A value of 1 displayed in this file indicates that the \"reset_devices=1\" "
401 "kernel parameter (used by B<kdump>) is honored by this controller. A value "
402 "of 0 indicates that the \"reset_devices=1\" kernel parameter will not be "
403 "honored. Some models of Smart Array are not able to honor this parameter."
407 #: build/C/man4/cciss.4:197
409 msgid "I</sys/bus/pci/devices/E<lt>devE<gt>/ccissX/cXdY/lunid>"
413 #: build/C/man4/cciss.4:203
415 "Displays the 8-byte LUN ID used to address logical drive I<Y> of controller "
420 #: build/C/man4/cciss.4:203
422 msgid "I</sys/bus/pci/devices/E<lt>devE<gt>/ccissX/cXdY/raid_level>"
426 #: build/C/man4/cciss.4:209
427 msgid "Displays the RAID level of logical drive I<Y> of controller I<X>."
431 #: build/C/man4/cciss.4:209
433 msgid "I</sys/bus/pci/devices/E<lt>devE<gt>/ccissX/cXdY/usage_count>"
437 #: build/C/man4/cciss.4:215
439 "Displays the usage count (number of opens) of logical drive I<Y> of "
444 #: build/C/man4/cciss.4:215
446 msgid "SCSI tape drive and medium changer support"
450 #: build/C/man4/cciss.4:226
452 "SCSI sequential access devices and medium changer devices are supported and "
453 "appropriate device nodes are automatically created (e.g., I</dev/st0>, "
454 "I</dev/st1>, etc.; see B<st>(4) for more details.) You must enable \"SCSI "
455 "tape drive support for Smart Array 5xxx\" and \"SCSI support\" in your "
456 "kernel configuration to be able to use SCSI tape drives with your Smart "
457 "Array 5xxx controller."
461 #: build/C/man4/cciss.4:244
463 "Additionally, note that the driver will not engage the SCSI core at init "
464 "time. The driver must be directed to dynamically engage the SCSI core via "
465 "the I</proc> filesystem entry, which the \"block\" side of the driver "
466 "creates as I</proc/driver/cciss/cciss*> at run time. This is because at "
467 "driver init time, the SCSI core may not yet be initialized (because the "
468 "driver is a block driver) and attempting to register it with the SCSI core "
469 "in such a case would cause a hang. This is best done via an initialization "
470 "script (typically in I</etc/init.d>, but could vary depending on "
471 "distribution). For example:"
475 #: build/C/man4/cciss.4:250
478 " for x in /proc/driver/cciss/cciss[0-9]*\n"
480 " echo \"engage scsi\" E<gt> $x\n"
485 #: build/C/man4/cciss.4:254
487 "Once the SCSI core is engaged by the driver, it cannot be disengaged (except "
488 "by unloading the driver, if it happens to be linked as a module.)"
492 #: build/C/man4/cciss.4:258
494 "Note also that if no sequential access devices or medium changers are "
495 "detected, the SCSI core will not be engaged by the action of the above "
500 #: build/C/man4/cciss.4:258
502 msgid "Hot plug support for SCSI tape drives"
506 #: build/C/man4/cciss.4:268
508 "Hot plugging of SCSI tape drives is supported, with some caveats. The "
509 "B<cciss> driver must be informed that changes to the SCSI bus have been "
510 "made. This may be done via the I</proc> filesystem. For example:"
514 #: build/C/man4/cciss.4:270
516 msgid " echo \"rescan\" E<gt> /proc/scsi/cciss0/1\n"
520 #: build/C/man4/cciss.4:272
521 msgid "This causes the driver to:"
525 #: build/C/man4/cciss.4:273 build/C/man4/initrd.4:97 build/C/man4/initrd.4:323 build/C/man4/initrd.4:430 build/C/man4/st.4:892 build/C/man7/uri.7:532
531 #: build/C/man4/cciss.4:276
533 "query the adapter about changes to the physical SCSI buses and/or fibre "
534 "channel arbitrated loop, and"
538 #: build/C/man4/cciss.4:276 build/C/man4/initrd.4:101 build/C/man4/initrd.4:331 build/C/man4/initrd.4:441 build/C/man4/st.4:912 build/C/man7/uri.7:536
544 #: build/C/man4/cciss.4:279
546 "make note of any new or removed sequential access devices or medium "
551 #: build/C/man4/cciss.4:286
553 "The driver will output messages indicating which devices have been added or "
554 "removed and the controller, bus, target and lun used to address each "
555 "device. The driver then notifies the SCSI midlayer of these changes."
559 #: build/C/man4/cciss.4:293
561 "Note that the naming convention of the I</proc> filesystem entries contains "
562 "a number in addition to the driver name (e.g., \"cciss0\" instead of just "
563 "\"cciss\", which you might expect)."
567 #: build/C/man4/cciss.4:311
569 "Note: I<Only> sequential access devices and medium changers are presented as "
570 "SCSI devices to the SCSI midlayer by the B<cciss> driver. Specifically, "
571 "physical SCSI disk drives are I<not> presented to the SCSI midlayer. The "
572 "only disk devices that are presented to the kernel are logical drives that "
573 "the array controller constructs from regions on the physical drives. The "
574 "logical drives are presented to the block layer (not to the SCSI midlayer). "
575 "It is important for the driver to prevent the kernel from accessing the "
576 "physical drives directly, since these drives are used by the array "
577 "controller to construct the logical drives."
581 #: build/C/man4/cciss.4:311
583 msgid "SCSI error handling for tape drives and medium changers"
587 #: build/C/man4/cciss.4:319
589 "The Linux SCSI midlayer provides an error-handling protocol that is "
590 "initiated whenever a SCSI command fails to complete within a certain amount "
591 "of time (which can vary depending on the command). The B<cciss> driver "
592 "participates in this protocol to some extent. The normal protocol is a "
597 #: build/C/man4/cciss.4:319 build/C/man4/cciss.4:321 build/C/man4/cciss.4:323 build/C/man4/cciss.4:325 build/C/man5/core.5:49 build/C/man5/core.5:61 build/C/man5/core.5:65 build/C/man5/core.5:69 build/C/man5/core.5:72 build/C/man5/core.5:85 build/C/man5/core.5:88 build/C/man5/core.5:101 build/C/man5/core.5:204 build/C/man5/core.5:208 build/C/man5/core.5:211 build/C/man5/core.5:215
603 #: build/C/man4/cciss.4:321
604 msgid "First, the device is told to abort the command."
608 #: build/C/man4/cciss.4:323
609 msgid "If that doesn't work, the device is reset."
613 #: build/C/man4/cciss.4:325
614 msgid "If that doesn't work, the SCSI bus is reset."
618 #: build/C/man4/cciss.4:327
619 msgid "If that doesn't work the host bus adapter is reset."
623 #: build/C/man4/cciss.4:345
625 "The B<cciss> driver is a block driver as well as a SCSI driver and only the "
626 "tape drives and medium changers are presented to the SCSI midlayer "
627 "Furthermore, unlike more straightforward SCSI drivers, disk I/O continues "
628 "through the block side during the SCSI error-recovery process Therefore, the "
629 "B<cciss> driver implements only the first two of these actions, aborting the "
630 "command, and resetting the device. Note also that most tape drives will not "
631 "oblige in aborting commands, and sometimes it appears they will not even "
632 "obey a reset command, though in most circumstances they will. If the "
633 "command cannot be aborted and the device cannot be reset, the device will be "
638 #: build/C/man4/cciss.4:353
640 "In the event that the error-handling code is triggered and a tape drive is "
641 "successfully reset or the tardy command is successfully aborted, the tape "
642 "drive may still not allow I/O to continue until some command is issued that "
643 "positions the tape to a known position. Typically you must rewind the tape "
644 "(by issuing I<mt -f /dev/st0 rewind> for example) before I/O can proceed "
645 "again to a tape drive that was reset."
649 #: build/C/man4/cciss.4:353 build/C/man4/console.4:95 build/C/man4/console_codes.4:642 build/C/man4/console_ioctl.4:846 build/C/man5/core.5:409 build/C/man4/cpuid.4:89 build/C/man4/dsp56k.4:115 build/C/man4/fd.4:213 build/C/man7/fifo.7:65 build/C/man4/full.4:61 build/C/man3/gnu_get_libc_version.3:76 build/C/man4/hd.4:105 build/C/man4/hpsa.4:179 build/C/man4/initrd.4:474 build/C/man4/lp.4:135 build/C/man3/makedev.3:80 build/C/man4/mem.4:84 build/C/man3/mkfifo.3:106 build/C/man2/mknod.2:209 build/C/man4/mouse.4:184 build/C/man4/msr.4:55 build/C/man4/null.4:64 build/C/man7/pipe.7:232 build/C/man4/ram.4:43 build/C/man4/random.4:282 build/C/man3/setlogmask.3:78 build/C/man4/sk98lin.4:611 build/C/man4/st.4:954 build/C/man2/syslog.2:309 build/C/man3/syslog.3:315 build/C/man4/ttyS.4:48 build/C/man7/uri.7:706 build/C/man4/vcs.4:173 build/C/man4/wavelan.4:138
655 #: build/C/man4/cciss.4:358
656 msgid "B<cciss_vol_status>(8), B<hpsa>(4), B<hpacucli>(8), B<hpacuxe>(8),"
660 #. Don Brace, Steve Cameron, Chase Maupin, Mike Miller, Michael Ni,
661 #. Charles White, Francis Wiran
662 #. and probably some other people.
664 #: build/C/man4/cciss.4:370
666 "E<.UR http://cciss.sf.net> E<.UE ,> and I<Documentation/blockdev/cciss.txt> "
667 "and I<Documentation/ABI/testing/sysfs-bus-pci-devices-cciss> in the Linux "
672 #: build/C/man4/cciss.4:370 build/C/man4/console.4:112 build/C/man4/console_codes.4:646 build/C/man4/console_ioctl.4:873 build/C/man5/core.5:420 build/C/man4/cpuid.4:96 build/C/man4/dsp56k.4:121 build/C/man4/fd.4:221 build/C/man7/fifo.7:74 build/C/man4/full.4:65 build/C/man3/gnu_get_libc_version.3:78 build/C/man4/hd.4:110 build/C/man4/hpsa.4:197 build/C/man4/initrd.4:484 build/C/man4/lp.4:141 build/C/man3/makedev.3:83 build/C/man4/mem.4:88 build/C/man3/mkfifo.3:116 build/C/man2/mknod.2:223 build/C/man4/mouse.4:187 build/C/man4/msr.4:59 build/C/man4/null.4:68 build/C/man7/pipe.7:244 build/C/man4/ram.4:47 build/C/man4/random.4:286 build/C/man4/sd.4:137 build/C/man3/setlogmask.3:82 build/C/man4/sk98lin.4:615 build/C/man4/st.4:964 build/C/man3/stdarg.3:329 build/C/man2/syslog.2:312 build/C/man3/syslog.3:320 build/C/man4/ttyS.4:55 build/C/man7/uri.7:715 build/C/man4/vcs.4:178 build/C/man4/wavelan.4:145
678 #: build/C/man4/cciss.4:377 build/C/man4/console.4:119 build/C/man4/console_codes.4:653 build/C/man4/console_ioctl.4:880 build/C/man5/core.5:427 build/C/man4/cpuid.4:103 build/C/man4/dsp56k.4:128 build/C/man4/fd.4:228 build/C/man7/fifo.7:81 build/C/man4/full.4:72 build/C/man3/gnu_get_libc_version.3:85 build/C/man4/hd.4:117 build/C/man4/hpsa.4:204 build/C/man4/initrd.4:491 build/C/man4/lp.4:148 build/C/man3/makedev.3:90 build/C/man4/mem.4:95 build/C/man3/mkfifo.3:123 build/C/man2/mknod.2:230 build/C/man4/mouse.4:194 build/C/man4/msr.4:66 build/C/man4/null.4:75 build/C/man7/pipe.7:251 build/C/man4/ram.4:54 build/C/man4/random.4:293 build/C/man4/sd.4:144 build/C/man3/setlogmask.3:89 build/C/man4/sk98lin.4:622 build/C/man4/st.4:971 build/C/man3/stdarg.3:336 build/C/man2/syslog.2:319 build/C/man3/syslog.3:327 build/C/man4/ttyS.4:62 build/C/man7/uri.7:722 build/C/man4/vcs.4:185 build/C/man4/wavelan.4:152
680 "This page is part of release 3.54 of the Linux I<man-pages> project. A "
681 "description of the project, and information about reporting bugs, can be "
682 "found at \\%http://www.kernel.org/doc/man-pages/."
686 #: build/C/man4/console.4:12
692 #: build/C/man4/console.4:12
698 #: build/C/man4/console.4:15
699 msgid "console - console terminal and virtual consoles"
703 #: build/C/man4/console.4:37
705 "A Linux system has up to 63 I<virtual consoles> (character devices with "
706 "major number 4 and minor number 1 to 63), usually called I</dev/ttyn> with 1 "
707 "\\(E<lt>= I<n> \\(E<lt>= 63. The current console is also addressed by "
708 "I</dev/console> or I</dev/tty0>, the character device with major number 4 "
709 "and minor number 0. The device files I</dev/*> are usually created using "
710 "the script MAKEDEV, or using B<mknod>(1), usually with mode 0622 and owner "
715 #: build/C/man4/console.4:45
717 "Before kernel version 1.1.54 the number of virtual consoles was compiled "
718 "into the kernel (in I<tty.h>: #define NR_CONSOLES 8) and could be changed "
719 "by editing and recompiling. Since version 1.1.54 virtual consoles are "
720 "created on the fly, as soon as they are needed."
724 #: build/C/man4/console.4:63
726 "Common ways to start a process on a console are: (a) tell B<init>(8) (in "
727 "B<inittab>(5)) to start a B<mingetty>(8) (or B<agetty>(8)) on the "
728 "console; (b) ask B<openvt>(1) to start a process on the console; (c) start "
729 "X\\(emit will find the first unused console, and display its output there. "
730 "(There is also the ancient B<doshell>(8).)"
734 #: build/C/man4/console.4:76
736 "Common ways to switch consoles are: (a) use Alt+FI<n> or Ctrl+Alt+FI<n> to "
737 "switch to console I<n>; AltGr+FI<n> might bring you to console I<n>+12 [here "
738 "Alt and AltGr refer to the left and right Alt keys, respectively]; (b) use "
739 "Alt+RightArrow or Alt+LeftArrow to cycle through the presently allocated "
740 "consoles; (c) use the program B<chvt>(1). (The key mapping is user "
741 "settable, see B<loadkeys>(1); the above mentioned key combinations are "
742 "according to the default settings.)"
746 #: build/C/man4/console.4:83
748 "The command B<deallocvt>(1) (formerly B<disalloc>) will free the memory "
749 "taken by the screen buffers for consoles that no longer have any associated "
754 #: build/C/man4/console.4:83
760 #: build/C/man4/console.4:91
762 "Consoles carry a lot of state. I hope to document that some other time. "
763 "The most important fact is that the consoles simulate vt100 terminals. In "
764 "particular, a console is reset to the initial state by printing the two "
765 "characters ESC c. All escape sequences can be found in B<console_codes>(4)."
769 #: build/C/man4/console.4:93
770 msgid "I</dev/console>"
774 #: build/C/man4/console.4:95
779 #: build/C/man4/console.4:112
781 "B<chvt>(1), B<deallocvt>(1), B<loadkeys>(1), B<mknod>(1), B<openvt>(1), "
782 "B<console_codes>(4), B<console_ioctl>(4), B<tty>(4), B<ttyS>(4), "
783 "B<charsets>(7), B<agetty>(8), B<init>(8), B<mapscrn>(8), B<mingetty>(8), "
784 "B<resizecons>(8), B<setfont>(8)"
788 #: build/C/man4/console_codes.4:23
790 msgid "CONSOLE_CODES"
794 #: build/C/man4/console_codes.4:26
795 msgid "console_codes - Linux console escape and control sequences"
799 #: build/C/man4/console_codes.4:33
801 "The Linux console implements a large subset of the VT102 and ECMA-48/ISO "
802 "6429/ANSI X3.64 terminal controls, plus certain private-mode sequences for "
803 "changing the color palette, character-set mapping, and so on. In the "
804 "tabular descriptions below, the second column gives ECMA-48 or DEC mnemonics "
805 "(the latter if prefixed with DEC) for the given function. Sequences without "
806 "a mnemonic are neither ECMA-48 nor VT102."
810 #: build/C/man4/console_codes.4:38
812 "After all the normal output processing has been done, and a stream of "
813 "characters arrives at the console driver for actual printing, the first "
814 "thing that happens is a translation from the code used for processing to the "
815 "code used for printing."
819 #: build/C/man4/console_codes.4:44
821 "If the console is in UTF-8 mode, then the incoming bytes are first assembled "
822 "into 16-bit Unicode codes. Otherwise each byte is transformed according to "
823 "the current mapping table (which translates it to a Unicode value). See the "
824 "B<Character Sets> section below for discussion."
828 #: build/C/man4/console_codes.4:50
830 "In the normal case, the Unicode value is converted to a font index, and this "
831 "is stored in video memory, so that the corresponding glyph (as found in "
832 "video ROM) appears on the screen. Note that the use of Unicode (and the "
833 "design of the PC hardware) allows us to use 512 different glyphs "
838 #: build/C/man4/console_codes.4:57
840 "If the current Unicode value is a control character, or we are currently "
841 "processing an escape sequence, the value will treated specially. Instead of "
842 "being turned into a font index and rendered as a glyph, it may trigger "
843 "cursor movement or other control functions. See the B<Linux Console "
844 "Controls> section below for discussion."
848 #: build/C/man4/console_codes.4:69
850 "It is generally not good practice to hard-wire terminal controls into "
851 "programs. Linux supports a B<terminfo>(5) database of terminal "
852 "capabilities. Rather than emitting console escape sequences by hand, you "
853 "will almost always want to use a terminfo-aware screen library or utility "
854 "such as B<ncurses>(3), B<tput>(1), or B<reset>(1)."
858 #: build/C/man4/console_codes.4:69
860 msgid "Linux console controls"
864 #: build/C/man4/console_codes.4:73
866 "This section describes all the control characters and escape sequences that "
867 "invoke special functions (i.e., anything other than writing a glyph at the "
868 "current cursor location) on the Linux console."
872 #: build/C/man4/console_codes.4:75
873 msgid "B<Control characters>"
877 #: build/C/man4/console_codes.4:86
879 "A character is a control character if (before transformation according to "
880 "the mapping table) it has one of the 14 codes 00 (NUL), 07 (BEL), 08 (BS), "
881 "09 (HT), 0a (LF), 0b (VT), 0c (FF), 0d (CR), 0e (SO), 0f (SI), 18 (CAN), 1a "
882 "(SUB), 1b (ESC), 7f (DEL). One can set a \"display control characters\" "
883 "mode (see below), and allow 07, 09, 0b, 18, 1a, 7f to be displayed as "
884 "glyphs. On the other hand, in UTF-8 mode all codes 00-1f are regarded as "
885 "control characters, regardless of any \"display control characters\" mode."
889 #: build/C/man4/console_codes.4:95
891 "If we have a control character, it is acted upon immediately and then "
892 "discarded (even in the middle of an escape sequence) and the escape "
893 "sequence continues with the next character. (However, ESC starts a new "
894 "escape sequence, possibly aborting a previous unfinished one, and CAN and "
895 "SUB abort any escape sequence.) The recognized control characters are BEL, "
896 "BS, HT, LF, VT, FF, CR, SO, SI, CAN, SUB, ESC, DEL, CSI. They do what one "
901 #: build/C/man4/console_codes.4:97
902 msgid "BEL (0x07, B<^G>) beeps;"
906 #: build/C/man4/console_codes.4:100
908 "BS (0x08, B<^H>) backspaces one column (but not past the beginning of the "
913 #: build/C/man4/console_codes.4:103
915 "HT (0x09, B<^I>) goes to the next tab stop or to the end of the line if "
916 "there is no earlier tab stop;"
920 #: build/C/man4/console_codes.4:107
922 "LF (0x0A, B<^J>), VT (0x0B, B<^K>) and FF (0x0C, B<^L>) all give a linefeed, "
923 "and if LF/NL (new-line mode) is set also a carriage return;"
927 #: build/C/man4/console_codes.4:109
928 msgid "CR (0x0D, B<^M>) gives a carriage return;"
932 #: build/C/man4/console_codes.4:111
933 msgid "SO (0x0E, B<^N>) activates the G1 character set;"
937 #: build/C/man4/console_codes.4:113
938 msgid "SI (0x0F, B<^O>) activates the G0 character set;"
942 #: build/C/man4/console_codes.4:115
943 msgid "CAN (0x18, B<^X>) and SUB (0x1A, B<^Z>) interrupt escape sequences;"
947 #: build/C/man4/console_codes.4:117
948 msgid "ESC (0x1B, B<^[>) starts an escape sequence;"
952 #: build/C/man4/console_codes.4:119
953 msgid "DEL (0x7F) is ignored;"
957 #: build/C/man4/console_codes.4:121
958 msgid "CSI (0x9B) is equivalent to ESC [."
962 #: build/C/man4/console_codes.4:123
963 msgid "B<ESC- but not CSI-sequences>"
967 #: build/C/man4/console_codes.4:125
969 msgid "ESC c\tRIS\tReset.\n"
973 #: build/C/man4/console_codes.4:126
975 msgid "ESC D\tIND\tLinefeed.\n"
979 #: build/C/man4/console_codes.4:127
981 msgid "ESC E\tNEL\tNewline.\n"
985 #: build/C/man4/console_codes.4:128
987 msgid "ESC H\tHTS\tSet tab stop at current column.\n"
991 #: build/C/man4/console_codes.4:129
993 msgid "ESC M\tRI\tReverse linefeed.\n"
997 #: build/C/man4/console_codes.4:130
999 msgid "ESC Z\tDECID\tT{\n"
1003 #: build/C/man4/console_codes.4:131
1005 msgid "DEC private identification. The kernel\n"
1009 #: build/C/man4/console_codes.4:132
1011 msgid "returns the string ESC [ ? 6 c, claiming\n"
1015 #: build/C/man4/console_codes.4:133
1017 msgid "that it is a VT102.\n"
1021 #: build/C/man4/console_codes.4:134 build/C/man4/console_codes.4:138 build/C/man4/console_codes.4:163 build/C/man4/console_codes.4:243 build/C/man4/console_codes.4:249 build/C/man4/console_codes.4:253 build/C/man4/console_codes.4:260
1027 #: build/C/man4/console_codes.4:135
1029 msgid "ESC 7\tDECSC\tT{\n"
1033 #: build/C/man4/console_codes.4:136
1035 msgid "Save current state (cursor coordinates,\n"
1039 #: build/C/man4/console_codes.4:137
1041 msgid "attributes, character sets pointed at by G0, G1).\n"
1045 #: build/C/man4/console_codes.4:139
1047 msgid "ESC 8\tDECRC\tRestore state most recently saved by ESC 7.\n"
1051 #: build/C/man4/console_codes.4:140
1053 msgid "ESC [\tCSI\tControl sequence introducer\n"
1057 #: build/C/man4/console_codes.4:141
1059 msgid "ESC %\t\tStart sequence selecting character set\n"
1063 #: build/C/man4/console_codes.4:142
1065 msgid "ESC % @\t\t\\0\\0\\0Select default (ISO 646 / ISO 8859-1)\n"
1069 #: build/C/man4/console_codes.4:143
1071 msgid "ESC % G\t\t\\0\\0\\0Select UTF-8\n"
1075 #: build/C/man4/console_codes.4:144
1077 msgid "ESC % 8\t\t\\0\\0\\0Select UTF-8 (obsolete)\n"
1081 #: build/C/man4/console_codes.4:145
1083 msgid "ESC # 8\tDECALN\tDEC screen alignment test - fill screen with E's.\n"
1087 #: build/C/man4/console_codes.4:146
1089 msgid "ESC (\t\tStart sequence defining G0 character set\n"
1093 #: build/C/man4/console_codes.4:147
1095 msgid "ESC ( B\t\t\\0\\0\\0Select default (ISO 8859-1 mapping)\n"
1099 #: build/C/man4/console_codes.4:148
1101 msgid "ESC ( 0\t\t\\0\\0\\0Select VT100 graphics mapping\n"
1105 #: build/C/man4/console_codes.4:149
1107 msgid "ESC ( U\t\t\\0\\0\\0Select null mapping - straight to character ROM\n"
1111 #: build/C/man4/console_codes.4:150
1113 msgid "ESC ( K\t\t\\0\\0\\0Select user mapping - the map that is loaded by\n"
1117 #: build/C/man4/console_codes.4:151
1119 msgid "\t\t\\0\\0\\0the utility B<mapscrn>(8).\n"
1123 #: build/C/man4/console_codes.4:152
1125 msgid "ESC )\t\tStart sequence defining G1\n"
1129 #: build/C/man4/console_codes.4:153
1131 msgid "\t\t(followed by one of B, 0, U, K, as above).\n"
1135 #: build/C/man4/console_codes.4:154
1137 msgid "ESC E<gt>\tDECPNM\tSet numeric keypad mode\n"
1141 #: build/C/man4/console_codes.4:155
1143 msgid "ESC =\tDECPAM\tSet application keypad mode\n"
1147 #: build/C/man4/console_codes.4:156
1149 msgid "ESC ]\tOSC\tT{\n"
1153 #: build/C/man4/console_codes.4:157
1155 msgid "(Should be: Operating system command)\n"
1159 #: build/C/man4/console_codes.4:158
1161 msgid "ESC ] P I<nrrggbb>: set palette, with parameter\n"
1165 #: build/C/man4/console_codes.4:159
1167 msgid "given in 7 hexadecimal digits after the final P :-(.\n"
1171 #: build/C/man4/console_codes.4:160
1173 msgid "Here I<n> is the color (0-15), and I<rrggbb> indicates\n"
1177 #: build/C/man4/console_codes.4:161
1179 msgid "the red/green/blue values (0-255).\n"
1183 #: build/C/man4/console_codes.4:162
1185 msgid "ESC ] R: reset palette\n"
1189 #: build/C/man4/console_codes.4:167
1190 msgid "B<ECMA-48 CSI sequences>"
1194 #: build/C/man4/console_codes.4:173
1196 "CSI (or ESC [) is followed by a sequence of parameters, at most NPAR (16), "
1197 "that are decimal numbers separated by semicolons. An empty or absent "
1198 "parameter is taken to be 0. The sequence of parameters may be preceded by a "
1199 "single question mark."
1203 #: build/C/man4/console_codes.4:177
1205 "However, after CSI [ (or ESC [ [) a single character is read and this entire "
1206 "sequence is ignored. (The idea is to ignore an echoed function key.)"
1210 #: build/C/man4/console_codes.4:179
1211 msgid "The action of a CSI sequence is determined by its final character."
1215 #: build/C/man4/console_codes.4:181
1217 msgid "@\tICH\tInsert the indicated # of blank characters.\n"
1221 #: build/C/man4/console_codes.4:182
1223 msgid "A\tCUU\tMove cursor up the indicated # of rows.\n"
1227 #: build/C/man4/console_codes.4:183
1229 msgid "B\tCUD\tMove cursor down the indicated # of rows.\n"
1233 #: build/C/man4/console_codes.4:184
1235 msgid "C\tCUF\tMove cursor right the indicated # of columns.\n"
1239 #: build/C/man4/console_codes.4:185
1241 msgid "D\tCUB\tMove cursor left the indicated # of columns.\n"
1245 #: build/C/man4/console_codes.4:186
1247 msgid "E\tCNL\tMove cursor down the indicated # of rows, to column 1.\n"
1251 #: build/C/man4/console_codes.4:187
1253 msgid "F\tCPL\tMove cursor up the indicated # of rows, to column 1.\n"
1257 #: build/C/man4/console_codes.4:188
1259 msgid "G\tCHA\tMove cursor to indicated column in current row.\n"
1263 #: build/C/man4/console_codes.4:189
1265 msgid "H\tCUP\tMove cursor to the indicated row, column (origin at 1,1).\n"
1269 #: build/C/man4/console_codes.4:190
1271 msgid "J\tED\tErase display (default: from cursor to end of display).\n"
1275 #: build/C/man4/console_codes.4:191
1277 msgid "\t\tESC [ 1 J: erase from start to cursor.\n"
1281 #: build/C/man4/console_codes.4:192
1283 msgid "\t\tESC [ 2 J: erase whole display.\n"
1287 #: build/C/man4/console_codes.4:193
1289 msgid "\t\tESC [ 3 J: erase whole display including scroll-back\n"
1293 #: build/C/man4/console_codes.4:194
1295 msgid "\t\t buffer (since Linux 3.0).\n"
1298 #. ESC [ 3 J: commit f8df13e0a901fe55631fed66562369b4dba40f8b
1300 #: build/C/man4/console_codes.4:196
1302 msgid "K\tEL\tErase line (default: from cursor to end of line).\n"
1306 #: build/C/man4/console_codes.4:197
1308 msgid "\t\tESC [ 1 K: erase from start of line to cursor.\n"
1312 #: build/C/man4/console_codes.4:198
1314 msgid "\t\tESC [ 2 K: erase whole line.\n"
1318 #: build/C/man4/console_codes.4:199
1320 msgid "L\tIL\tInsert the indicated # of blank lines.\n"
1324 #: build/C/man4/console_codes.4:200
1326 msgid "M\tDL\tDelete the indicated # of lines.\n"
1330 #: build/C/man4/console_codes.4:201
1332 msgid "P\tDCH\tDelete the indicated # of characters on current line.\n"
1336 #: build/C/man4/console_codes.4:202
1338 msgid "X\tECH\tErase the indicated # of characters on current line.\n"
1342 #: build/C/man4/console_codes.4:203
1344 msgid "a\tHPR\tMove cursor right the indicated # of columns.\n"
1348 #: build/C/man4/console_codes.4:204
1350 msgid "c\tDA\tAnswer ESC [ ? 6 c: \"I am a VT102\".\n"
1354 #: build/C/man4/console_codes.4:205
1356 msgid "d\tVPA\tMove cursor to the indicated row, current column.\n"
1360 #: build/C/man4/console_codes.4:206
1362 msgid "e\tVPR\tMove cursor down the indicated # of rows.\n"
1366 #: build/C/man4/console_codes.4:207
1368 msgid "f\tHVP\tMove cursor to the indicated row, column.\n"
1372 #: build/C/man4/console_codes.4:208
1374 msgid "g\tTBC\tWithout parameter: clear tab stop at current position.\n"
1378 #: build/C/man4/console_codes.4:209
1380 msgid "\t\tESC [ 3 g: delete all tab stops.\n"
1384 #: build/C/man4/console_codes.4:210
1386 msgid "h\tSM\tSet Mode (see below).\n"
1390 #: build/C/man4/console_codes.4:211
1392 msgid "l\tRM\tReset Mode (see below).\n"
1396 #: build/C/man4/console_codes.4:212
1398 msgid "m\tSGR\tSet attributes (see below).\n"
1402 #: build/C/man4/console_codes.4:213
1404 msgid "n\tDSR\tStatus report (see below).\n"
1408 #: build/C/man4/console_codes.4:214
1410 msgid "q\tDECLL\tSet keyboard LEDs.\n"
1414 #: build/C/man4/console_codes.4:215
1416 msgid "\t\tESC [ 0 q: clear all LEDs\n"
1420 #: build/C/man4/console_codes.4:216
1422 msgid "\t\tESC [ 1 q: set Scroll Lock LED\n"
1426 #: build/C/man4/console_codes.4:217
1428 msgid "\t\tESC [ 2 q: set Num Lock LED\n"
1432 #: build/C/man4/console_codes.4:218
1434 msgid "\t\tESC [ 3 q: set Caps Lock LED\n"
1438 #: build/C/man4/console_codes.4:219
1440 msgid "r\tDECSTBM\tSet scrolling region; parameters are top and bottom row.\n"
1444 #: build/C/man4/console_codes.4:220
1446 msgid "s\t?\tSave cursor location.\n"
1450 #: build/C/man4/console_codes.4:221
1452 msgid "u\t?\tRestore cursor location.\n"
1456 #: build/C/man4/console_codes.4:222
1458 msgid "\\`\tHPA\tMove cursor to indicated column in current row.\n"
1462 #: build/C/man4/console_codes.4:226
1463 msgid "B<ECMA-48 Set Graphics Rendition>"
1467 #: build/C/man4/console_codes.4:233
1469 "The ECMA-48 SGR sequence ESC [ I<parameters> m sets display attributes. "
1470 "Several attributes can be set in the same sequence, separated by "
1471 "semicolons. An empty parameter (between semicolons or string initiator or "
1472 "terminator) is interpreted as a zero."
1476 #: build/C/man4/console_codes.4:235
1478 msgid "param\tresult\n"
1482 #: build/C/man4/console_codes.4:236
1484 msgid "0\treset all attributes to their defaults\n"
1488 #: build/C/man4/console_codes.4:237
1490 msgid "1\tset bold\n"
1494 #: build/C/man4/console_codes.4:238
1496 msgid "2\tset half-bright (simulated with color on a color display)\n"
1500 #: build/C/man4/console_codes.4:239
1506 #: build/C/man4/console_codes.4:240
1508 msgid "set underscore (simulated with color on a color display)\n"
1512 #: build/C/man4/console_codes.4:241
1514 msgid "(the colors used to simulate dim or underline are set\n"
1518 #: build/C/man4/console_codes.4:242
1520 msgid "using ESC ] ...)\n"
1524 #: build/C/man4/console_codes.4:244
1526 msgid "5\tset blink\n"
1530 #: build/C/man4/console_codes.4:245
1532 msgid "7\tset reverse video\n"
1536 #: build/C/man4/console_codes.4:246
1542 #: build/C/man4/console_codes.4:247
1544 msgid "reset selected mapping, display control flag,\n"
1548 #: build/C/man4/console_codes.4:248
1550 msgid "and toggle meta flag (ECMA-48 says \"primary font\").\n"
1554 #: build/C/man4/console_codes.4:250
1560 #: build/C/man4/console_codes.4:251 build/C/man4/console_codes.4:255
1562 msgid "select null mapping, set display control flag,\n"
1566 #: build/C/man4/console_codes.4:252
1568 msgid "reset toggle meta flag (ECMA-48 says \"first alternate font\").\n"
1572 #: build/C/man4/console_codes.4:254
1578 #: build/C/man4/console_codes.4:256
1580 msgid "set toggle meta flag (ECMA-48 says \"second alternate font\").\n"
1584 #: build/C/man4/console_codes.4:257
1586 msgid "The toggle meta flag\n"
1590 #: build/C/man4/console_codes.4:258
1592 msgid "causes the high bit of a byte to be toggled\n"
1596 #: build/C/man4/console_codes.4:259
1598 msgid "before the mapping table translation is done.\n"
1602 #: build/C/man4/console_codes.4:261
1604 msgid "21\tset normal intensity (ECMA-48 says \"doubly underlined\")\n"
1608 #: build/C/man4/console_codes.4:262
1610 msgid "22\tset normal intensity\n"
1614 #: build/C/man4/console_codes.4:263
1616 msgid "24\tunderline off\n"
1620 #: build/C/man4/console_codes.4:264
1622 msgid "25\tblink off\n"
1626 #: build/C/man4/console_codes.4:265
1628 msgid "27\treverse video off\n"
1632 #: build/C/man4/console_codes.4:266
1634 msgid "30\tset black foreground\n"
1638 #: build/C/man4/console_codes.4:267
1640 msgid "31\tset red foreground\n"
1644 #: build/C/man4/console_codes.4:268
1646 msgid "32\tset green foreground\n"
1650 #: build/C/man4/console_codes.4:269
1652 msgid "33\tset brown foreground\n"
1656 #: build/C/man4/console_codes.4:270
1658 msgid "34\tset blue foreground\n"
1662 #: build/C/man4/console_codes.4:271
1664 msgid "35\tset magenta foreground\n"
1668 #: build/C/man4/console_codes.4:272
1670 msgid "36\tset cyan foreground\n"
1674 #: build/C/man4/console_codes.4:273
1676 msgid "37\tset white foreground\n"
1680 #: build/C/man4/console_codes.4:274
1682 msgid "38\tset underscore on, set default foreground color\n"
1686 #: build/C/man4/console_codes.4:275
1688 msgid "39\tset underscore off, set default foreground color\n"
1692 #: build/C/man4/console_codes.4:276
1694 msgid "40\tset black background\n"
1698 #: build/C/man4/console_codes.4:277
1700 msgid "41\tset red background\n"
1704 #: build/C/man4/console_codes.4:278
1706 msgid "42\tset green background\n"
1710 #: build/C/man4/console_codes.4:279
1712 msgid "43\tset brown background\n"
1716 #: build/C/man4/console_codes.4:280
1718 msgid "44\tset blue background\n"
1722 #: build/C/man4/console_codes.4:281
1724 msgid "45\tset magenta background\n"
1728 #: build/C/man4/console_codes.4:282
1730 msgid "46\tset cyan background\n"
1734 #: build/C/man4/console_codes.4:283
1736 msgid "47\tset white background\n"
1740 #: build/C/man4/console_codes.4:284
1742 msgid "49\tset default background color\n"
1746 #: build/C/man4/console_codes.4:288
1747 msgid "B<ECMA-48 Mode Switches>"
1751 #: build/C/man4/console_codes.4:288
1757 #: build/C/man4/console_codes.4:291
1758 msgid "DECCRM (default off): Display control chars."
1762 #: build/C/man4/console_codes.4:291
1768 #: build/C/man4/console_codes.4:294
1769 msgid "DECIM (default off): Set insert mode."
1773 #: build/C/man4/console_codes.4:294
1779 #: build/C/man4/console_codes.4:298
1780 msgid "LF/NL (default off): Automatically follow echo of LF, VT or FF with CR."
1784 #: build/C/man4/console_codes.4:301
1785 msgid "B<ECMA-48 Status Report Commands>"
1789 #: build/C/man4/console_codes.4:301
1795 #: build/C/man4/console_codes.4:304
1796 msgid "Device status report (DSR): Answer is ESC [ 0 n (Terminal OK)."
1800 #: build/C/man4/console_codes.4:304
1806 #: build/C/man4/console_codes.4:309
1808 "Cursor position report (CPR): Answer is ESC [ I<y> ; I<x> R, where I<x,y> is "
1809 "the cursor location."
1813 #: build/C/man4/console_codes.4:311
1814 msgid "B<DEC Private Mode (DECSET/DECRST) sequences>"
1818 #: build/C/man4/console_codes.4:317
1820 "These are not described in ECMA-48. We list the Set Mode sequences; the "
1821 "Reset Mode sequences are obtained by replacing the final \\(aqh\\(aq by "
1826 #: build/C/man4/console_codes.4:317
1832 #: build/C/man4/console_codes.4:321
1834 "DECCKM (default off): When set, the cursor keys send an ESC O prefix, rather "
1839 #: build/C/man4/console_codes.4:321
1845 #: build/C/man4/console_codes.4:328
1847 "DECCOLM (default off = 80 columns): 80/132 col mode switch. The driver "
1848 "sources note that this alone does not suffice; some user-mode utility such "
1849 "as B<resizecons>(8) has to change the hardware registers on the console "
1854 #: build/C/man4/console_codes.4:328
1860 #: build/C/man4/console_codes.4:331
1861 msgid "DECSCNM (default off): Set reverse-video mode."
1865 #: build/C/man4/console_codes.4:331
1871 #: build/C/man4/console_codes.4:335
1873 "DECOM (default off): When set, cursor addressing is relative to the upper "
1874 "left corner of the scrolling region."
1878 #: build/C/man4/console_codes.4:335
1884 #: build/C/man4/console_codes.4:341
1886 "DECAWM (default on): Set autowrap on. In this mode, a graphic character "
1887 "emitted after column 80 (or column 132 of DECCOLM is on) forces a wrap to "
1888 "the beginning of the following line first."
1892 #: build/C/man4/console_codes.4:341
1898 #: build/C/man4/console_codes.4:344
1899 msgid "DECARM (default on): Set keyboard autorepeat on."
1903 #: build/C/man4/console_codes.4:344
1909 #: build/C/man4/console_codes.4:348
1911 "X10 Mouse Reporting (default off): Set reporting mode to 1 (or reset to "
1916 #: build/C/man4/console_codes.4:348
1918 msgid "ESC [ ? 25 h"
1922 #: build/C/man4/console_codes.4:351
1923 msgid "DECTECM (default on): Make cursor visible."
1927 #: build/C/man4/console_codes.4:351
1929 msgid "ESC [ ? 1000 h"
1933 #: build/C/man4/console_codes.4:356
1935 "X11 Mouse Reporting (default off): Set reporting mode to 2 (or reset to "
1940 #: build/C/man4/console_codes.4:358
1941 msgid "B<Linux Console Private CSI Sequences>"
1945 #: build/C/man4/console_codes.4:365
1947 "The following sequences are neither ECMA-48 nor native VT102. They are "
1948 "native to the Linux console driver. Colors are in SGR parameters: 0 = "
1949 "black, 1 = red, 2 = green, 3 = brown, 4 = blue, 5 = magenta, 6 = cyan, 7 = "
1954 #: build/C/man4/console_codes.4:367
1956 msgid "ESC [ 1 ; I<n> ]\tSet color I<n> as the underline color\n"
1960 #: build/C/man4/console_codes.4:368
1962 msgid "ESC [ 2 ; I<n> ]\tSet color I<n> as the dim color\n"
1966 #: build/C/man4/console_codes.4:369
1968 msgid "ESC [ 8 ] \tMake the current color pair the default attributes.\n"
1972 #: build/C/man4/console_codes.4:370
1974 msgid "ESC [ 9 ; I<n> ]\tSet screen blank timeout to I<n> minutes.\n"
1978 #: build/C/man4/console_codes.4:371
1980 msgid "ESC [ 10 ; I<n> ]\tSet bell frequency in Hz.\n"
1984 #: build/C/man4/console_codes.4:372
1986 msgid "ESC [ 11 ; I<n> ]\tSet bell duration in msec.\n"
1990 #: build/C/man4/console_codes.4:373
1992 msgid "ESC [ 12 ; I<n> ]\tBring specified console to the front.\n"
1996 #: build/C/man4/console_codes.4:374
1998 msgid "ESC [ 13 ] \tUnblank the screen.\n"
2002 #: build/C/man4/console_codes.4:375
2004 msgid "ESC [ 14 ; I<n> ] \tSet the VESA powerdown interval in minutes.\n"
2008 #: build/C/man4/console_codes.4:377
2010 msgid "Character sets"
2014 #: build/C/man4/console_codes.4:382
2016 "The kernel knows about 4 translations of bytes into console-screen symbols. "
2017 "The four tables are: a) Latin1 -E<gt> PC, b) VT100 graphics -E<gt> PC, c) PC "
2018 "-E<gt> PC, d) user-defined."
2022 #: build/C/man4/console_codes.4:388
2024 "There are two character sets, called G0 and G1, and one of them is the "
2025 "current character set. (Initially G0.) Typing B<^N> causes G1 to become "
2026 "current, B<^O> causes G0 to become current."
2030 #: build/C/man4/console_codes.4:396
2032 "These variables G0 and G1 point at a translation table, and can be changed "
2033 "by the user. Initially they point at tables a) and b), respectively. The "
2034 "sequences ESC ( B and ESC ( 0 and ESC ( U and ESC ( K cause G0 to point at "
2035 "translation table a), b), c) and d), respectively. The sequences ESC ) B "
2036 "and ESC ) 0 and ESC ) U and ESC ) K cause G1 to point at translation table "
2037 "a), b), c) and d), respectively."
2041 #: build/C/man4/console_codes.4:406
2043 "The sequence ESC c causes a terminal reset, which is what you want if the "
2044 "screen is all garbled. The oft-advised \"echo ^V^O\" will make only G0 "
2045 "current, but there is no guarantee that G0 points at table a). In some "
2046 "distributions there is a program B<reset>(1) that just does \"echo ^[c\". "
2047 "If your terminfo entry for the console is correct (and has an entry "
2048 "rs1=\\eEc), then \"tput reset\" will also work."
2052 #: build/C/man4/console_codes.4:414
2054 "The user-defined mapping table can be set using B<mapscrn>(8). The result "
2055 "of the mapping is that if a symbol c is printed, the symbol s = map[c] is "
2056 "sent to the video memory. The bitmap that corresponds to s is found in the "
2057 "character ROM, and can be changed using B<setfont>(8)."
2061 #: build/C/man4/console_codes.4:414
2063 msgid "Mouse tracking"
2067 #: build/C/man4/console_codes.4:426
2069 "The mouse tracking facility is intended to return B<xterm>(1)-compatible "
2070 "mouse status reports. Because the console driver has no way to know the "
2071 "device or type of the mouse, these reports are returned in the console input "
2072 "stream only when the virtual terminal driver receives a mouse update ioctl. "
2073 "These ioctls must be generated by a mouse-aware user-mode application such "
2074 "as the B<gpm>(8) daemon."
2078 #: build/C/man4/console_codes.4:432
2080 "The mouse tracking escape sequences generated by B<xterm>(1) encode numeric "
2081 "parameters in a single character as I<value>+040. For example, \\(aq!\\(aq "
2082 "is 1. The screen coordinate system is 1-based."
2086 #: build/C/man4/console_codes.4:442
2088 "The X10 compatibility mode sends an escape sequence on button press encoding "
2089 "the location and the mouse button pressed. It is enabled by sending ESC [ ? "
2090 "9 h and disabled with ESC [ ? 9 l. On button press, B<xterm>(1) sends ESC [ "
2091 "M I<bxy> (6 characters). Here I<b> is button-1, and I<x> and I<y> are the x "
2092 "and y coordinates of the mouse when the button was pressed. This is the "
2093 "same code the kernel also produces."
2097 #: build/C/man4/console_codes.4:457
2099 "Normal tracking mode (not implemented in Linux 2.0.24) sends an escape "
2100 "sequence on both button press and release. Modifier information is also "
2101 "sent. It is enabled by sending ESC [ ? 1000 h and disabled with ESC [ ? "
2102 "1000 l. On button press or release, B<xterm>(1) sends ESC [ M I<bxy>. The "
2103 "low two bits of I<b> encode button information: 0=MB1 pressed, 1=MB2 "
2104 "pressed, 2=MB3 pressed, 3=release. The upper bits encode what modifiers "
2105 "were down when the button was pressed and are added together: 4=Shift, "
2106 "8=Meta, 16=Control. Again I<x> and I<y> are the x and y coordinates of the "
2107 "mouse event. The upper left corner is (1,1)."
2111 #: build/C/man4/console_codes.4:457
2113 msgid "Comparisons with other terminals"
2117 #: build/C/man4/console_codes.4:464
2119 "Many different terminal types are described, like the Linux console, as "
2120 "being \"VT100-compatible\". Here we discuss differences between the Linux "
2121 "console and the two most important others, the DEC VT102 and B<xterm>(1)."
2125 #: build/C/man4/console_codes.4:466
2126 msgid "B<Control-character handling>"
2130 #: build/C/man4/console_codes.4:468
2131 msgid "The VT102 also recognized the following control characters:"
2135 #: build/C/man4/console_codes.4:470
2136 msgid "NUL (0x00) was ignored;"
2140 #: build/C/man4/console_codes.4:472
2141 msgid "ENQ (0x05) triggered an answerback message;"
2145 #: build/C/man4/console_codes.4:474
2146 msgid "DC1 (0x11, B<^Q>, XON) resumed transmission;"
2150 #: build/C/man4/console_codes.4:477
2152 "DC3 (0x13, B<^S>, XOFF) caused VT100 to ignore (and stop transmitting) all "
2153 "codes except XOFF and XON."
2157 #: build/C/man4/console_codes.4:479
2158 msgid "VT100-like DC1/DC3 processing may be enabled by the terminal driver."
2162 #: build/C/man4/console_codes.4:485
2164 "The B<xterm>(1) program (in VT100 mode) recognizes the control characters "
2165 "BEL, BS, HT, LF, VT, FF, CR, SO, SI, ESC."
2169 #: build/C/man4/console_codes.4:487
2170 msgid "B<Escape sequences>"
2174 #: build/C/man4/console_codes.4:489
2175 msgid "VT100 console sequences not implemented on the Linux console:"
2179 #: build/C/man4/console_codes.4:491
2181 msgid "ESC N\tSS2\tSingle shift 2. (Select G2 character set for the next\n"
2185 #: build/C/man4/console_codes.4:492 build/C/man4/console_codes.4:494
2187 msgid "\t\tcharacter only.)\n"
2191 #: build/C/man4/console_codes.4:493
2193 msgid "ESC O\tSS3\tSingle shift 3. (Select G3 character set for the next\n"
2197 #: build/C/man4/console_codes.4:495
2199 msgid "ESC P\tDCS\tDevice control string (ended by ESC \\e)\n"
2203 #: build/C/man4/console_codes.4:496
2205 msgid "ESC X\tSOS\tStart of string.\n"
2209 #: build/C/man4/console_codes.4:497
2211 msgid "ESC ^\tPM\tPrivacy message (ended by ESC \\e)\n"
2215 #: build/C/man4/console_codes.4:498
2217 msgid "ESC \\e\tST\tString terminator\n"
2221 #: build/C/man4/console_codes.4:499
2223 msgid "ESC * ...\t\tDesignate G2 character set\n"
2227 #: build/C/man4/console_codes.4:500
2229 msgid "ESC + ...\t\tDesignate G3 character set\n"
2233 #: build/C/man4/console_codes.4:513
2235 "The program B<xterm>(1) (in VT100 mode) recognizes ESC c, ESC # 8, ESC "
2236 "E<gt>, ESC =, ESC D, ESC E, ESC H, ESC M, ESC N, ESC O, ESC P ... ESC \\e, "
2237 "ESC Z (it answers ESC [ ? 1 ; 2 c, \"I am a VT100 with advanced video "
2238 "option\") and ESC ^ ... ESC \\e with the same meanings as indicated above. "
2239 "It accepts ESC (, ESC ), ESC *, ESC + followed by 0, A, B for the DEC "
2240 "special character and line drawing set, UK, and US-ASCII, respectively."
2244 #: build/C/man4/console_codes.4:517
2246 "The user can configure B<xterm>(1) to respond to VT220-specific control "
2247 "sequences, and it will identify itself as a VT52, VT100, and up depending on "
2248 "the way it is configured and initialized."
2252 #: build/C/man4/console_codes.4:522
2254 "It accepts ESC ] (OSC) for the setting of certain resources. In addition to "
2255 "the ECMA-48 string terminator (ST), B<xterm>(1) accepts a BEL to terminate "
2256 "an OSC string. These are a few of the OSC control sequences recognized by "
2261 #: build/C/man4/console_codes.4:524
2263 msgid "ESC ] 0 ; I<txt> ST\tSet icon name and window title to I<txt>.\n"
2267 #: build/C/man4/console_codes.4:525
2269 msgid "ESC ] 1 ; I<txt> ST\tSet icon name to I<txt>.\n"
2273 #: build/C/man4/console_codes.4:526
2275 msgid "ESC ] 2 ; I<txt> ST\tSet window title to I<txt>.\n"
2279 #: build/C/man4/console_codes.4:527
2281 msgid "ESC ] 4 ; I<num>; I<txt> ST\tSet ANSI color I<num> to I<txt>.\n"
2285 #: build/C/man4/console_codes.4:528
2287 msgid "ESC ] 10 ; I<txt> ST\tSet dynamic text color to I<txt>.\n"
2291 #: build/C/man4/console_codes.4:529
2293 msgid "ESC ] 4 6 ; I<name> ST\tChange log file to I<name> (normally disabled\n"
2297 #: build/C/man4/console_codes.4:530
2299 msgid "\tby a compile-time option)\n"
2303 #: build/C/man4/console_codes.4:531
2305 msgid "ESC ] 5 0 ; I<fn> ST\tSet font to I<fn>.\n"
2309 #: build/C/man4/console_codes.4:536
2311 "It recognizes the following with slightly modified meaning (saving more "
2312 "state, behaving closer to VT100/VT220):"
2316 #: build/C/man4/console_codes.4:538
2318 msgid "ESC 7 DECSC\tSave cursor\n"
2322 #: build/C/man4/console_codes.4:539
2324 msgid "ESC 8 DECRC\tRestore cursor\n"
2328 #: build/C/man4/console_codes.4:543
2329 msgid "It also recognizes"
2333 #: build/C/man4/console_codes.4:545
2335 msgid "ESC F\t\tCursor to lower left corner of screen (if enabled by\n"
2339 #: build/C/man4/console_codes.4:546
2341 msgid "\t\tB<xterm>(1)'s B<hpLowerleftBugCompat> resource)\n"
2345 #: build/C/man4/console_codes.4:547
2347 msgid "ESC l\t\tMemory lock (per HP terminals).\n"
2351 #: build/C/man4/console_codes.4:548
2353 msgid "\t\tLocks memory above the cursor.\n"
2357 #: build/C/man4/console_codes.4:549
2359 msgid "ESC m\t\tMemory unlock (per HP terminals).\n"
2363 #: build/C/man4/console_codes.4:550
2365 msgid "ESC n\tLS2\tInvoke the G2 character set.\n"
2369 #: build/C/man4/console_codes.4:551
2371 msgid "ESC o\tLS3\tInvoke the G3 character set.\n"
2375 #: build/C/man4/console_codes.4:552
2377 msgid "ESC |\tLS3R\tInvoke the G3 character set as GR.\n"
2381 #: build/C/man4/console_codes.4:553
2383 msgid "ESC }\tLS2R\tInvoke the G2 character set as GR.\n"
2387 #: build/C/man4/console_codes.4:554
2389 msgid "ESC ~\tLS1R\tInvoke the G1 character set as GR.\n"
2393 #: build/C/man4/console_codes.4:560
2395 "It also recognizes ESC % and provides a more complete UTF-8 implementation "
2396 "than Linux console."
2400 #: build/C/man4/console_codes.4:562
2401 msgid "B<CSI Sequences>"
2405 #: build/C/man4/console_codes.4:576
2407 "Old versions of B<xterm>(1), for example, from X11R5, interpret the blink "
2408 "SGR as a bold SGR. Later versions which implemented ANSI colors, for "
2409 "example, XFree86 3.1.2A in 1995, improved this by allowing the blink "
2410 "attribute to be displayed as a color. Modern versions of xterm implement "
2411 "blink SGR as blinking text and still allow colored text as an alternate "
2412 "rendering of SGRs. Stock X11R6 versions did not recognize the color-setting "
2413 "SGRs until the X11R6.8 release, which incorporated XFree86 xterm. All "
2414 "ECMA-48 CSI sequences recognized by Linux are also recognized by I<xterm>, "
2415 "however B<xterm>(1) implements several ECMA-48 and DEC control sequences not "
2416 "recognized by Linux."
2420 #: build/C/man4/console_codes.4:590
2422 "The B<xterm>(1) program recognizes all of the DEC Private Mode sequences "
2423 "listed above, but none of the Linux private-mode sequences. For discussion "
2424 "of B<xterm>(1)'s own private-mode sequences, refer to the I<Xterm Control "
2425 "Sequences> document by Edward Moy, Stephen Gildea, and Thomas E. Dickey "
2426 "available with the X distribution. That document, though terse, is much "
2427 "longer than this manual page. For a chronological overview,"
2431 #: build/C/man4/console_codes.4:594
2432 msgid "E<.UR http://invisible-island.net\\:/xterm\\:/xterm.log.html> E<.UE>"
2436 #: build/C/man4/console_codes.4:597
2437 msgid "details changes to xterm."
2441 #: build/C/man4/console_codes.4:599
2442 msgid "The I<vttest> program"
2446 #: build/C/man4/console_codes.4:603
2447 msgid "E<.UR http://invisible-island.net\\:/vttest/> E<.UE>"
2451 #: build/C/man4/console_codes.4:608
2453 "demonstrates many of these control sequences. The B<xterm>(1) source "
2454 "distribution also contains sample scripts which exercise other features."
2458 #: build/C/man4/console_codes.4:608 build/C/man4/console_ioctl.4:824 build/C/man5/core.5:297 build/C/man4/cpuid.4:62 build/C/man4/fd.4:196 build/C/man7/fifo.7:54 build/C/man4/initrd.4:429 build/C/man3/makedev.3:71 build/C/man2/mknod.2:182 build/C/man4/msr.4:47 build/C/man4/null.4:61 build/C/man4/st.4:891 build/C/man3/stdarg.3:239 build/C/man2/syslog.2:301 build/C/man3/syslog.3:296 build/C/man7/uri.7:592
2464 #: build/C/man4/console_codes.4:611
2465 msgid "ESC 8 (DECRC) is not able to restore the character set changed with ESC %."
2469 #: build/C/man4/console_codes.4:611 build/C/man4/sk98lin.4:605 build/C/man3/stdarg.3:275 build/C/man7/uri.7:673
2475 #: build/C/man4/console_codes.4:614
2476 msgid "In 2.0.23, CSI is broken, and NUL is not ignored inside escape sequences."
2480 #: build/C/man4/console_codes.4:623
2482 "Some older kernel versions (after 2.0) interpret 8-bit control sequences. "
2483 "These \"C1 controls\" use codes between 128 and 159 to replace ESC [, ESC ] "
2484 "and similar two-byte control sequence initiators. There are fragments of "
2485 "that in modern kernels (either overlooked or broken by changes to support "
2486 "UTF-8), but the implementation is incomplete and should be regarded as "
2491 #: build/C/man4/console_codes.4:638
2493 "Linux \"private mode\" sequences do not follow the rules in ECMA-48 for "
2494 "private mode control sequences. In particular, those ending with ] do not "
2495 "use a standard terminating character. The OSC (set palette) sequence is a "
2496 "greater problem, since B<xterm>(1) may interpret this as a control sequence "
2497 "which requires a string terminator (ST). Unlike the B<setterm>(1) sequences "
2498 "which will be ignored (since they are invalid control sequences), the "
2499 "palette sequence will make B<xterm>(1) appear to hang (though pressing the "
2500 "return-key will fix that). To accommodate applications which have been "
2501 "hardcoded to use Linux control sequences, set the B<xterm>(1) resource "
2502 "B<brokenLinuxOSC> to true."
2506 #: build/C/man4/console_codes.4:642
2508 "An older version of this document implied that Linux recognizes the ECMA-48 "
2509 "control sequence for invisible text. It is ignored."
2513 #: build/C/man4/console_codes.4:646
2514 msgid "B<console>(4), B<console_ioctl>(4), B<charsets>(7)"
2518 #: build/C/man4/console_ioctl.4:40
2520 msgid "CONSOLE_IOCTL"
2524 #: build/C/man4/console_ioctl.4:40
2530 #: build/C/man4/console_ioctl.4:43
2531 msgid "console_ioctl - ioctls for console terminal and virtual consoles"
2535 #: build/C/man4/console_ioctl.4:49
2537 "The following Linux-specific B<ioctl>(2) requests are supported. Each "
2538 "requires a third argument, assumed here to be I<argp>."
2542 #: build/C/man4/console_ioctl.4:49
2548 #: build/C/man4/console_ioctl.4:59
2550 "Get state of LEDs. I<argp> points to a I<char>. The lower three bits of "
2551 "I<*argp> are set to the state of the LEDs, as follows:"
2555 #: build/C/man4/console_ioctl.4:61
2557 msgid "LED_CAP \t0x04\tcaps lock led\n"
2561 #: build/C/man4/console_ioctl.4:62
2563 msgid "LEC_NUM \t0x02\tnum lock led\n"
2567 #: build/C/man4/console_ioctl.4:63
2569 msgid "LED_SCR \t0x01\tscroll lock led\n"
2573 #: build/C/man4/console_ioctl.4:65
2579 #: build/C/man4/console_ioctl.4:73
2581 "Set the LEDs. The LEDs are set to correspond to the lower three bits of "
2582 "I<argp>. However, if a higher order bit is set, the LEDs revert to normal: "
2583 "displaying the state of the keyboard functions of caps lock, num lock, and "
2588 #: build/C/man4/console_ioctl.4:80
2590 "Before 1.1.54, the LEDs just reflected the state of the corresponding "
2591 "keyboard flags, and KDGETLED/KDSETLED would also change the keyboard flags. "
2592 "Since 1.1.54 the LEDs can be made to display arbitrary information, but by "
2593 "default they display the keyboard flags. The following two ioctls are used "
2594 "to access the keyboard flags."
2598 #: build/C/man4/console_ioctl.4:80
2604 #: build/C/man4/console_ioctl.4:89
2606 "Get keyboard flags CapsLock, NumLock, ScrollLock (not lights). I<argp> "
2607 "points to a char which is set to the flag state. The low order three bits "
2608 "(mask 0x7) get the current flag state, and the low order bits of the next "
2609 "nibble (mask 0x70) get the default flag state. (Since 1.1.54.)"
2613 #: build/C/man4/console_ioctl.4:89
2619 #: build/C/man4/console_ioctl.4:98
2621 "Set keyboard flags CapsLock, NumLock, ScrollLock (not lights). I<argp> has "
2622 "the desired flag state. The low order three bits (mask 0x7) have the flag "
2623 "state, and the low order bits of the next nibble (mask 0x70) have the "
2624 "default flag state. (Since 1.1.54.)"
2628 #: build/C/man4/console_ioctl.4:98
2630 msgid "B<KDGKBTYPE>"
2634 #: build/C/man4/console_ioctl.4:102
2635 msgid "Get keyboard type. This returns the value KB_101, defined as 0x02."
2639 #: build/C/man4/console_ioctl.4:102
2645 #: build/C/man4/console_ioctl.4:107
2646 msgid "Add I/O port as valid. Equivalent to I<ioperm(arg,1,1)>."
2650 #: build/C/man4/console_ioctl.4:107
2656 #: build/C/man4/console_ioctl.4:112
2657 msgid "Delete I/O port as valid. Equivalent to I<ioperm(arg,1,0)>."
2661 #: build/C/man4/console_ioctl.4:112
2667 #: build/C/man4/console_ioctl.4:117
2669 "Enable I/O to video board. Equivalent to I<ioperm(0x3b4, 0x3df-0x3b4+1, "
2674 #: build/C/man4/console_ioctl.4:117
2676 msgid "B<KDDISABIO>"
2680 #: build/C/man4/console_ioctl.4:122
2682 "Disable I/O to video board. Equivalent to I<ioperm(0x3b4, 0x3df-0x3b4+1, "
2687 #: build/C/man4/console_ioctl.4:122
2689 msgid "B<KDSETMODE>"
2693 #: build/C/man4/console_ioctl.4:127
2694 msgid "Set text/graphics mode. I<argp> is one of these:"
2698 #: build/C/man4/console_ioctl.4:130
2700 msgid "KD_TEXT\t0x00\n"
2704 #: build/C/man4/console_ioctl.4:131
2706 msgid "KD_GRAPHICS\t0x01\n"
2710 #: build/C/man4/console_ioctl.4:133
2712 msgid "B<KDGETMODE>"
2716 #: build/C/man4/console_ioctl.4:141
2718 "Get text/graphics mode. I<argp> points to a I<long> which is set to one of "
2723 #: build/C/man4/console_ioctl.4:141
2729 #: build/C/man4/console_ioctl.4:155
2731 "Generate tone of specified length. The lower 16 bits of I<argp> specify the "
2732 "period in clock cycles, and the upper 16 bits give the duration in msec. If "
2733 "the duration is zero, the sound is turned off. Control returns "
2734 "immediately. For example, I<argp> = (125E<lt>E<lt>16) + 0x637 would specify "
2735 "the beep normally associated with a ctrl-G. (Thus since 0.99pl1; broken in "
2740 #: build/C/man4/console_ioctl.4:155
2742 msgid "B<KIOCSOUND>"
2746 #: build/C/man4/console_ioctl.4:167
2748 "Start or stop sound generation. The lower 16 bits of I<argp> specify the "
2749 "period in clock cycles (that is, I<argp> = 1193180/frequency). I<argp> = 0 "
2750 "turns sound off. In either case, control returns immediately."
2754 #: build/C/man4/console_ioctl.4:167
2760 #: build/C/man4/console_ioctl.4:174
2762 "Get the current default color map from kernel. I<argp> points to a 48-byte "
2763 "array. (Since 1.3.3.)"
2767 #: build/C/man4/console_ioctl.4:174
2773 #: build/C/man4/console_ioctl.4:187
2775 "Change the default text-mode color map. I<argp> points to a 48-byte array "
2776 "which contains, in order, the Red, Green, and Blue values for the 16 "
2777 "available screen colors: 0 is off, and 255 is full intensity. The default "
2778 "colors are, in order: black, dark red, dark green, brown, dark blue, dark "
2779 "purple, dark cyan, light grey, dark grey, bright red, bright green, yellow, "
2780 "bright blue, bright purple, bright cyan and white. (Since 1.3.3.)"
2784 #: build/C/man4/console_ioctl.4:187
2790 #: build/C/man4/console_ioctl.4:197
2792 "Gets 256-character screen font in expanded form. I<argp> points to an 8192 "
2793 "byte array. Fails with error code B<EINVAL> if the currently loaded font is "
2794 "a 512-character font, or if the console is not in text mode."
2798 #: build/C/man4/console_ioctl.4:197
2800 msgid "B<GIO_FONTX>"
2804 #: build/C/man4/console_ioctl.4:225
2806 "Gets screen font and associated information. I<argp> points to a I<struct "
2807 "consolefontdesc> (see B<PIO_FONTX>). On call, the I<charcount> field should "
2808 "be set to the maximum number of characters that would fit in the buffer "
2809 "pointed to by I<chardata>. On return, the I<charcount> and I<charheight> "
2810 "are filled with the respective data for the currently loaded font, and the "
2811 "I<chardata> array contains the font data if the initial value of "
2812 "I<charcount> indicated enough space was available; otherwise the buffer is "
2813 "untouched and I<errno> is set to B<ENOMEM>. (Since 1.3.1.)"
2817 #: build/C/man4/console_ioctl.4:225
2823 #: build/C/man4/console_ioctl.4:240
2825 "Sets 256-character screen font. Load font into the EGA/VGA character "
2826 "generator. I<argp> points to a 8192 byte map, with 32 bytes per character. "
2827 "Only the first I<N> of them are used for an 8xI<N> font (0 E<lt> I<N> E<lt>= "
2828 "32). This call also invalidates the Unicode mapping."
2832 #: build/C/man4/console_ioctl.4:240
2834 msgid "B<PIO_FONTX>"
2838 #: build/C/man4/console_ioctl.4:245
2839 msgid "Sets screen font and associated rendering information. I<argp> points to a"
2843 #: build/C/man4/console_ioctl.4:256
2846 "struct consolefontdesc {\n"
2847 " unsigned short charcount; /* characters in font\n"
2848 " (256 or 512) */\n"
2849 " unsigned short charheight; /* scan lines per\n"
2850 " character (1-32) */\n"
2851 " char *chardata; /* font data in\n"
2852 " expanded form */\n"
2857 #: build/C/man4/console_ioctl.4:264
2859 "If necessary, the screen will be appropriately resized, and B<SIGWINCH> sent "
2860 "to the appropriate processes. This call also invalidates the Unicode "
2861 "mapping. (Since 1.3.1.)"
2865 #: build/C/man4/console_ioctl.4:264
2867 msgid "B<PIO_FONTRESET>"
2871 #: build/C/man4/console_ioctl.4:272
2873 "Resets the screen font, size and Unicode mapping to the bootup defaults. "
2874 "I<argp> is unused, but should be set to NULL to ensure compatibility with "
2875 "future versions of Linux. (Since 1.3.28.)"
2879 #: build/C/man4/console_ioctl.4:272
2881 msgid "B<GIO_SCRNMAP>"
2885 #: build/C/man4/console_ioctl.4:281
2887 "Get screen mapping from kernel. I<argp> points to an area of size E_TABSZ, "
2888 "which is loaded with the font positions used to display each character. "
2889 "This call is likely to return useless information if the currently loaded "
2890 "font is more than 256 characters."
2894 #: build/C/man4/console_ioctl.4:281
2896 msgid "B<GIO_UNISCRNMAP>"
2900 #: build/C/man4/console_ioctl.4:293
2902 "Get full Unicode screen mapping from kernel. I<argp> points to an area of "
2903 "size I<E_TABSZ*sizeof(unsigned short)>, which is loaded with the Unicodes "
2904 "each character represent. A special set of Unicodes, starting at U+F000, "
2905 "are used to represent \"direct to font\" mappings. (Since 1.3.1.)"
2909 #: build/C/man4/console_ioctl.4:293
2911 msgid "B<PIO_SCRNMAP>"
2915 #: build/C/man4/console_ioctl.4:300
2917 "Loads the \"user definable\" (fourth) table in the kernel which maps bytes "
2918 "into console screen symbols. I<argp> points to an area of size E_TABSZ."
2922 #: build/C/man4/console_ioctl.4:300
2924 msgid "B<PIO_UNISCRNMAP>"
2928 #: build/C/man4/console_ioctl.4:308
2930 "Loads the \"user definable\" (fourth) table in the kernel which maps bytes "
2931 "into Unicodes, which are then translated into screen symbols according to "
2932 "the currently loaded Unicode-to-font map. Special Unicodes starting at "
2933 "U+F000 can be used to map directly to the font symbols. (Since 1.3.1.)"
2937 #: build/C/man4/console_ioctl.4:308
2939 msgid "B<GIO_UNIMAP>"
2943 #: build/C/man4/console_ioctl.4:313
2944 msgid "Get Unicode-to-font mapping from kernel. I<argp> points to a"
2948 #: build/C/man4/console_ioctl.4:320
2951 "struct unimapdesc {\n"
2952 " unsigned short entry_ct;\n"
2953 " struct unipair *entries;\n"
2958 #: build/C/man4/console_ioctl.4:326
2959 msgid "where I<entries> points to an array of"
2963 #: build/C/man4/console_ioctl.4:333
2966 "struct unipair {\n"
2967 " unsigned short unicode;\n"
2968 " unsigned short fontpos;\n"
2973 #: build/C/man4/console_ioctl.4:337 build/C/man4/console_ioctl.4:361
2974 msgid "(Since 1.1.92.)"
2978 #: build/C/man4/console_ioctl.4:337
2980 msgid "B<PIO_UNIMAP>"
2984 #: build/C/man4/console_ioctl.4:344
2986 "Put unicode-to-font mapping in kernel. I<argp> points to a I<struct "
2987 "unimapdesc>. (Since 1.1.92)"
2991 #: build/C/man4/console_ioctl.4:344
2993 msgid "B<PIO_UNIMAPCLR>"
2997 #: build/C/man4/console_ioctl.4:349
2998 msgid "Clear table, possibly advise hash algorithm. I<argp> points to a"
3002 #: build/C/man4/console_ioctl.4:357
3005 "struct unimapinit {\n"
3006 " unsigned short advised_hashsize; /* 0 if no opinion */\n"
3007 " unsigned short advised_hashstep; /* 0 if no opinion */\n"
3008 " unsigned short advised_hashlevel; /* 0 if no opinion */\n"
3013 #: build/C/man4/console_ioctl.4:361
3015 msgid "B<KDGKBMODE>"
3019 #: build/C/man4/console_ioctl.4:369
3021 "Gets current keyboard mode. I<argp> points to a I<long> which is set to one "
3026 #: build/C/man4/console_ioctl.4:372
3028 msgid "K_RAW\t0x00\n"
3032 #: build/C/man4/console_ioctl.4:373
3034 msgid "K_XLATE\t0x01\n"
3038 #: build/C/man4/console_ioctl.4:374
3040 msgid "K_MEDIUMRAW\t0x02\n"
3044 #: build/C/man4/console_ioctl.4:375
3046 msgid "K_UNICODE\t0x03\n"
3050 #: build/C/man4/console_ioctl.4:377
3052 msgid "B<KDSKBMODE>"
3056 #: build/C/man4/console_ioctl.4:384
3058 "Sets current keyboard mode. I<argp> is a I<long> equal to one of the above "
3063 #: build/C/man4/console_ioctl.4:384
3065 msgid "B<KDGKBMETA>"
3069 #: build/C/man4/console_ioctl.4:392
3071 "Gets meta key handling mode. I<argp> points to a I<long> which is set to "
3076 #: build/C/man4/console_ioctl.4:395
3078 msgid "K_METABIT\t0x03\tset high order bit\n"
3082 #: build/C/man4/console_ioctl.4:396
3084 msgid "K_ESCPREFIX\t0x04\tescape prefix\n"
3088 #: build/C/man4/console_ioctl.4:398
3090 msgid "B<KDSKBMETA>"
3094 #: build/C/man4/console_ioctl.4:405
3096 "Sets meta key handling mode. I<argp> is a I<long> equal to one of the above "
3101 #: build/C/man4/console_ioctl.4:405
3107 #: build/C/man4/console_ioctl.4:410
3109 "Gets one entry in key translation table (keycode to action code). I<argp> "
3114 #: build/C/man4/console_ioctl.4:418
3117 "struct kbentry {\n"
3118 " unsigned char kb_table;\n"
3119 " unsigned char kb_index;\n"
3120 " unsigned short kb_value;\n"
3125 #: build/C/man4/console_ioctl.4:437
3127 "with the first two members filled in: I<kb_table> selects the key table (0 "
3128 "E<lt>= I<kb_table> E<lt> MAX_NR_KEYMAPS), and I<kb_index> is the keycode (0 "
3129 "E<lt>= I<kb_index> E<lt> NR_KEYS). I<kb_value> is set to the corresponding "
3130 "action code, or K_HOLE if there is no such key, or K_NOSUCHMAP if "
3131 "I<kb_table> is invalid."
3135 #: build/C/man4/console_ioctl.4:437
3141 #: build/C/man4/console_ioctl.4:443
3142 msgid "Sets one entry in translation table. I<argp> points to a I<struct kbentry>."
3146 #: build/C/man4/console_ioctl.4:443
3148 msgid "B<KDGKBSENT>"
3152 #: build/C/man4/console_ioctl.4:448
3153 msgid "Gets one function key string. I<argp> points to a"
3157 #: build/C/man4/console_ioctl.4:455
3160 "struct kbsentry {\n"
3161 " unsigned char kb_func;\n"
3162 " unsigned char kb_string[512];\n"
3167 #: build/C/man4/console_ioctl.4:463
3169 "I<kb_string> is set to the (null-terminated) string corresponding to the "
3170 "I<kb_func>th function key action code."
3174 #: build/C/man4/console_ioctl.4:463
3176 msgid "B<KDSKBSENT>"
3180 #: build/C/man4/console_ioctl.4:469
3181 msgid "Sets one function key string entry. I<argp> points to a I<struct kbsentry>."
3185 #: build/C/man4/console_ioctl.4:469
3187 msgid "B<KDGKBDIACR>"
3191 #: build/C/man4/console_ioctl.4:474
3192 msgid "Read kernel accent table. I<argp> points to a"
3196 #: build/C/man4/console_ioctl.4:481
3199 "struct kbdiacrs {\n"
3200 " unsigned int kb_cnt;\n"
3201 " struct kbdiacr kbdiacr[256];\n"
3206 #: build/C/man4/console_ioctl.4:488
3207 msgid "where I<kb_cnt> is the number of entries in the array, each of which is a"
3211 #: build/C/man4/console_ioctl.4:496
3214 "struct kbdiacr {\n"
3215 " unsigned char diacr;\n"
3216 " unsigned char base;\n"
3217 " unsigned char result;\n"
3222 #: build/C/man4/console_ioctl.4:498
3224 msgid "B<KDGETKEYCODE>"
3228 #: build/C/man4/console_ioctl.4:503
3229 msgid "Read kernel keycode table entry (scan code to keycode). I<argp> points to a"
3233 #: build/C/man4/console_ioctl.4:510
3236 "struct kbkeycode {\n"
3237 " unsigned int scancode;\n"
3238 " unsigned int keycode;\n"
3243 #: build/C/man4/console_ioctl.4:524
3245 "I<keycode> is set to correspond to the given I<scancode>. (89 E<lt>= "
3246 "I<scancode> E<lt>= 255 only. For 1 E<lt>= I<scancode> E<lt>= 88, "
3247 "I<keycode>==I<scancode>.) (Since 1.1.63.)"
3251 #: build/C/man4/console_ioctl.4:524
3253 msgid "B<KDSETKEYCODE>"
3257 #: build/C/man4/console_ioctl.4:531
3259 "Write kernel keycode table entry. I<argp> points to a I<struct kbkeycode>. "
3264 #: build/C/man4/console_ioctl.4:531
3266 msgid "B<KDSIGACCEPT>"
3270 #: build/C/man4/console_ioctl.4:543
3272 "The calling process indicates its willingness to accept the signal I<argp> "
3273 "when it is generated by pressing an appropriate key combination. (1 E<lt>= "
3274 "I<argp> E<lt>= NSIG). (See I<spawn_console>() in "
3275 "I<linux/drivers/char/keyboard.c>.)"
3279 #: build/C/man4/console_ioctl.4:543
3281 msgid "B<VT_OPENQRY>"
3285 #: build/C/man4/console_ioctl.4:553
3287 "Returns the first available (non-opened) console. I<argp> points to an "
3288 "I<int> which is set to the number of the vt (1 E<lt>= I<*argp> E<lt>= "
3293 #: build/C/man4/console_ioctl.4:553
3295 msgid "B<VT_GETMODE>"
3299 #: build/C/man4/console_ioctl.4:558
3300 msgid "Get mode of active vt. I<argp> points to a"
3304 #: build/C/man4/console_ioctl.4:568
3307 "struct vt_mode {\n"
3308 " char mode; /* vt mode */\n"
3309 " char waitv; /* if set, hang on writes if not active */\n"
3310 " short relsig; /* signal to raise on release req */\n"
3311 " short acqsig; /* signal to raise on acquisition */\n"
3312 " short frsig; /* unused (set to 0) */\n"
3317 #: build/C/man4/console_ioctl.4:574
3319 "which is set to the mode of the active vt. I<mode> is set to one of these "
3324 #: build/C/man4/console_ioctl.4:577
3326 msgid "VT_AUTO\tauto vt switching\n"
3330 #: build/C/man4/console_ioctl.4:578
3332 msgid "VT_PROCESS\tprocess controls switching\n"
3336 #: build/C/man4/console_ioctl.4:579
3338 msgid "VT_ACKACQ\tacknowledge switch\n"
3342 #: build/C/man4/console_ioctl.4:581
3344 msgid "B<VT_SETMODE>"
3348 #: build/C/man4/console_ioctl.4:587
3349 msgid "Set mode of active vt. I<argp> points to a I<struct vt_mode>."
3353 #: build/C/man4/console_ioctl.4:587
3355 msgid "B<VT_GETSTATE>"
3359 #: build/C/man4/console_ioctl.4:592
3360 msgid "Get global vt state info. I<argp> points to a"
3364 #: build/C/man4/console_ioctl.4:600
3367 "struct vt_stat {\n"
3368 " unsigned short v_active; /* active vt */\n"
3369 " unsigned short v_signal; /* signal to send */\n"
3370 " unsigned short v_state; /* vt bit mask */\n"
3375 #: build/C/man4/console_ioctl.4:607
3377 "For each vt in use, the corresponding bit in the I<v_state> member is set. "
3378 "(Kernels 1.0 through 1.1.92.)"
3382 #: build/C/man4/console_ioctl.4:607
3384 msgid "B<VT_RELDISP>"
3388 #: build/C/man4/console_ioctl.4:610
3389 msgid "Release a display."
3393 #: build/C/man4/console_ioctl.4:610
3395 msgid "B<VT_ACTIVATE>"
3399 #: build/C/man4/console_ioctl.4:617
3400 msgid "Switch to vt I<argp> (1 E<lt>= I<argp> E<lt>= MAX_NR_CONSOLES)."
3404 #: build/C/man4/console_ioctl.4:617
3406 msgid "B<VT_WAITACTIVE>"
3410 #: build/C/man4/console_ioctl.4:622
3411 msgid "Wait until vt I<argp> has been activated."
3415 #: build/C/man4/console_ioctl.4:622
3417 msgid "B<VT_DISALLOCATE>"
3421 #: build/C/man4/console_ioctl.4:627
3422 msgid "Deallocate the memory associated with vt I<argp>. (Since 1.1.54.)"
3426 #: build/C/man4/console_ioctl.4:627
3428 msgid "B<VT_RESIZE>"
3432 #: build/C/man4/console_ioctl.4:632
3433 msgid "Set the kernel's idea of screensize. I<argp> points to a"
3437 #: build/C/man4/console_ioctl.4:640
3440 "struct vt_sizes {\n"
3441 " unsigned short v_rows; /* # rows */\n"
3442 " unsigned short v_cols; /* # columns */\n"
3443 " unsigned short v_scrollsize; /* no longer used */\n"
3448 #: build/C/man4/console_ioctl.4:647
3450 "Note that this does not change the videomode. See B<resizecons>(8). (Since "
3455 #: build/C/man4/console_ioctl.4:647
3457 msgid "B<VT_RESIZEX>"
3461 #: build/C/man4/console_ioctl.4:652
3462 msgid "Set the kernel's idea of various screen parameters. I<argp> points to a"
3466 #: build/C/man4/console_ioctl.4:667
3469 "struct vt_consize {\n"
3470 " unsigned short v_rows; /* number of rows */\n"
3471 " unsigned short v_cols; /* number of columns */\n"
3472 " unsigned short v_vlin; /* number of pixel rows\n"
3474 " unsigned short v_clin; /* number of pixel rows\n"
3475 " per character */\n"
3476 " unsigned short v_vcol; /* number of pixel columns\n"
3478 " unsigned short v_ccol; /* number of pixel columns\n"
3479 " per character */\n"
3484 #: build/C/man4/console_ioctl.4:676
3486 "Any parameter may be set to zero, indicating \"no change\", but if multiple "
3487 "parameters are set, they must be self-consistent. Note that this does not "
3488 "change the videomode. See B<resizecons>(8). (Since 1.3.3.)"
3492 #: build/C/man4/console_ioctl.4:683
3494 "The action of the following ioctls depends on the first byte in the struct "
3495 "pointed to by I<argp>, referred to here as the I<subcode>. These are legal "
3496 "only for the superuser or the owner of the current terminal."
3500 #: build/C/man4/console_ioctl.4:683
3502 msgid "B<TIOCLINUX, subcode=0>"
3506 #: build/C/man4/console_ioctl.4:691
3508 "Dump the screen. Disappeared in 1.1.92. (With kernel 1.1.92 or later, read "
3509 "from I</dev/vcsN> or I</dev/vcsaN> instead.)"
3513 #: build/C/man4/console_ioctl.4:691
3515 msgid "B<TIOCLINUX, subcode=1>"
3519 #: build/C/man4/console_ioctl.4:695
3520 msgid "Get task information. Disappeared in 1.1.92."
3524 #: build/C/man4/console_ioctl.4:695
3526 msgid "B<TIOCLINUX, subcode=2>"
3530 #: build/C/man4/console_ioctl.4:700
3531 msgid "Set selection. I<argp> points to a"
3535 #: build/C/man4/console_ioctl.4:708
3540 " short xs, ys, xe, ye;\n"
3541 " short sel_mode;\n"
3546 #: build/C/man4/console_ioctl.4:728
3548 "I<xs> and I<ys> are the starting column and row. I<xe> and I<ye> are the "
3549 "ending column and row. (Upper left corner is row=column=1.) I<sel_mode> is "
3550 "0 for character-by-character selection, 1 for word-by-word selection, or 2 "
3551 "for line-by-line selection. The indicated screen characters are highlighted "
3552 "and saved in the static array sel_buffer in I<devices/char/console.c>."
3556 #: build/C/man4/console_ioctl.4:728
3558 msgid "B<TIOCLINUX, subcode=3>"
3562 #: build/C/man4/console_ioctl.4:734
3564 "Paste selection. The characters in the selection buffer are written to "
3569 #: build/C/man4/console_ioctl.4:734
3571 msgid "B<TIOCLINUX, subcode=4>"
3575 #: build/C/man4/console_ioctl.4:737
3576 msgid "Unblank the screen."
3580 #: build/C/man4/console_ioctl.4:737
3582 msgid "B<TIOCLINUX, subcode=5>"
3586 #: build/C/man4/console_ioctl.4:742
3588 "Sets contents of a 256-bit look up table defining characters in a \"word\", "
3589 "for word-by-word selection. (Since 1.1.32.)"
3593 #: build/C/man4/console_ioctl.4:742
3595 msgid "B<TIOCLINUX, subcode=6>"
3599 #: build/C/man4/console_ioctl.4:749
3601 "I<argp> points to a char which is set to the value of the kernel variable "
3602 "I<shift_state>. (Since 1.1.32.)"
3606 #: build/C/man4/console_ioctl.4:749
3608 msgid "B<TIOCLINUX, subcode=7>"
3612 #: build/C/man4/console_ioctl.4:756
3614 "I<argp> points to a char which is set to the value of the kernel variable "
3615 "I<report_mouse>. (Since 1.1.33.)"
3619 #: build/C/man4/console_ioctl.4:756
3621 msgid "B<TIOCLINUX, subcode=8>"
3625 #: build/C/man4/console_ioctl.4:764
3627 "Dump screen width and height, cursor position, and all the "
3628 "character-attribute pairs. (Kernels 1.1.67 through 1.1.91 only. With "
3629 "kernel 1.1.92 or later, read from I</dev/vcsa*> instead.)"
3633 #: build/C/man4/console_ioctl.4:764
3635 msgid "B<TIOCLINUX, subcode=9>"
3639 #: build/C/man4/console_ioctl.4:772
3641 "Restore screen width and height, cursor position, and all the "
3642 "character-attribute pairs. (Kernels 1.1.67 through 1.1.91 only. With "
3643 "kernel 1.1.92 or later, write to I</dev/vcsa*> instead.)"
3647 #: build/C/man4/console_ioctl.4:772
3649 msgid "B<TIOCLINUX, subcode=10>"
3653 #: build/C/man4/console_ioctl.4:780
3655 "Handles the Power Saving feature of the new generation of monitors. VESA "
3656 "screen blanking mode is set to I<argp[1]>, which governs what screen "
3661 #: build/C/man4/console_ioctl.4:781
3667 #: build/C/man4/console_ioctl.4:783
3668 msgid "Screen blanking is disabled."
3672 #: build/C/man4/console_ioctl.4:783
3678 #: build/C/man4/console_ioctl.4:790
3680 "The current video adapter register settings are saved, then the controller "
3681 "is programmed to turn off the vertical synchronization pulses. This puts "
3682 "the monitor into \"standby\" mode. If your monitor has an Off_Mode timer, "
3683 "then it will eventually power down by itself."
3687 #: build/C/man4/console_ioctl.4:790
3693 #: build/C/man4/console_ioctl.4:800
3695 "The current settings are saved, then both the vertical and horizontal "
3696 "synchronization pulses are turned off. This puts the monitor into \"off\" "
3697 "mode. If your monitor has no Off_Mode timer, or if you want your monitor to "
3698 "power down immediately when the blank_timer times out, then you choose this "
3699 "option. (I<Caution:> Powering down frequently will damage the monitor.) "
3704 #: build/C/man4/console_ioctl.4:801 build/C/man3/mkfifo.3:61 build/C/man2/mknod.2:101 build/C/man3/setlogmask.3:69 build/C/man4/st.4:827 build/C/man2/syslog.2:244
3706 msgid "RETURN VALUE"
3710 #: build/C/man4/console_ioctl.4:806
3711 msgid "On success, 0 is returned. On error, -1 is returned, and I<errno> is set."
3715 #: build/C/man4/console_ioctl.4:806 build/C/man3/mkfifo.3:67 build/C/man2/mknod.2:106 build/C/man3/setlogmask.3:71 build/C/man2/syslog.2:260
3721 #: build/C/man4/console_ioctl.4:809
3722 msgid "I<errno> may take on these values:"
3726 #: build/C/man4/console_ioctl.4:809
3732 #: build/C/man4/console_ioctl.4:812
3733 msgid "The file descriptor is invalid."
3737 #: build/C/man4/console_ioctl.4:812
3743 #: build/C/man4/console_ioctl.4:816
3745 "The file descriptor is not associated with a character special device, or "
3746 "the specified request does not apply to it."
3750 #: build/C/man4/console_ioctl.4:816 build/C/man2/mknod.2:129 build/C/man4/st.4:842 build/C/man2/syslog.2:261
3756 #: build/C/man4/console_ioctl.4:821
3757 msgid "The file descriptor or I<argp> is invalid."
3761 #: build/C/man4/console_ioctl.4:821 build/C/man2/mknod.2:159 build/C/man2/syslog.2:285
3767 #: build/C/man4/console_ioctl.4:824
3768 msgid "Insufficient permission."
3772 #: build/C/man4/console_ioctl.4:835
3774 "B<Warning>: Do not regard this man page as documentation of the Linux "
3775 "console ioctls. This is provided for the curious only, as an alternative to "
3776 "reading the source. Ioctl's are undocumented Linux internals, liable to be "
3777 "changed without warning. (And indeed, this page more or less describes the "
3778 "situation as of kernel version 1.1.94; there are many minor and not-so-minor "
3779 "differences with earlier versions.)"
3783 #: build/C/man4/console_ioctl.4:840
3785 "Very often, ioctls are introduced for communication between the kernel and "
3786 "one particular well-known program (fdisk, hdparm, setserial, tunelp, "
3787 "loadkeys, selection, setfont, etc.), and their behavior will be changed when "
3788 "required by this particular program."
3792 #: build/C/man4/console_ioctl.4:844
3794 "Programs using these ioctls will not be portable to other versions of UNIX, "
3795 "will not work on older versions of Linux, and will not work on future "
3796 "versions of Linux."
3800 #: build/C/man4/console_ioctl.4:846
3801 msgid "Use POSIX functions."
3805 #: build/C/man4/console_ioctl.4:870
3807 "B<dumpkeys>(1), B<kbd_mode>(1), B<loadkeys>(1), B<mknod>(1), B<setleds>(1), "
3808 "B<setmetamode>(1), B<execve>(2), B<fcntl>(2), B<ioperm>(2), B<termios>(3), "
3809 "B<console>(4), B<console_codes>(4), B<mt>(4), B<sd>(4), B<tty>(4), "
3810 "B<tty_ioctl>(4), B<ttyS>(4), B<vcs>(4), B<vcsa>(4), B<charsets>(7), "
3811 "B<mapscrn>(8), B<resizecons>(8), B<setfont>(8)"
3815 #: build/C/man4/console_ioctl.4:873
3816 msgid "I</usr/include/linux/kd.h>, I</usr/include/linux/vt.h>"
3820 #: build/C/man5/core.5:25
3826 #: build/C/man5/core.5:25
3832 #: build/C/man5/core.5:28
3833 msgid "core - core dump file"
3837 #: build/C/man5/core.5:39
3839 "The default action of certain signals is to cause a process to terminate and "
3840 "produce a I<core dump file>, a disk file containing an image of the "
3841 "process's memory at the time of termination. This image can be used in a "
3842 "debugger (e.g., B<gdb>(1)) to inspect the state of the program at the time "
3843 "that it terminated. A list of the signals which cause a process to dump "
3844 "core can be found in B<signal>(7)."
3848 #: build/C/man5/core.5:46
3850 "A process can set its soft B<RLIMIT_CORE> resource limit to place an upper "
3851 "limit on the size of the core dump file that will be produced if it receives "
3852 "a \"core dump\" signal; see B<getrlimit>(2) for details."
3856 #: build/C/man5/core.5:49
3857 msgid "There are various circumstances in which a core dump file is not produced:"
3861 #: build/C/man5/core.5:61
3863 "The process does not have permission to write the core file. (By default "
3864 "the core file is called I<core>, and is created in the current working "
3865 "directory. See below for details on naming.) Writing the core file will "
3866 "fail if the directory in which it is to be created is nonwritable, or if a "
3867 "file with the same name exists and is not writable or is not a regular file "
3868 "(e.g., it is a directory or a symbolic link)."
3872 #: build/C/man5/core.5:65
3874 "A (writable, regular) file with the same name as would be used for the core "
3875 "dump already exists, but there is more than one hard link to that file."
3879 #: build/C/man5/core.5:69
3881 "The filesystem where the core dump file would be created is full; or has run "
3882 "out of inodes; or is mounted read-only; or the user has reached their quota "
3883 "for the filesystem."
3887 #: build/C/man5/core.5:72
3888 msgid "The directory in which the core dump file is to be created does not exist."
3892 #: build/C/man5/core.5:85
3894 "The B<RLIMIT_CORE> (core file size) or B<RLIMIT_FSIZE> (file size) resource "
3895 "limits for the process are set to zero; see B<getrlimit>(2) and the "
3896 "documentation of the shell's I<ulimit> command (I<limit> in B<csh>(1))."
3900 #: build/C/man5/core.5:88
3902 "The binary being executed by the process does not have read permission "
3906 #. FIXME . Perhaps relocate discussion of /proc/sys/fs/suid_dumpable
3907 #. and PR_SET_DUMPABLE to this page?
3909 #: build/C/man5/core.5:101
3911 "The process is executing a set-user-ID (set-group-ID) program that is owned "
3912 "by a user (group) other than the real user (group) ID of the process. "
3913 "(However, see the description of the B<prctl>(2) B<PR_SET_DUMPABLE> "
3914 "operation, and the description of the I</proc/sys/fs/suid_dumpable> file in "
3918 #. commit 046d662f481830e652ac34cd112249adde16452a
3920 #: build/C/man5/core.5:107
3922 "(Since Linux 3.7) The kernel was configured without the B<CONFIG_COREDUMP> "
3927 #: build/C/man5/core.5:113
3929 "In addition, a core dump may exclude part of the address space of the "
3930 "process if the B<madvise>(2) B<MADV_DONTDUMP> flag was employed."
3934 #: build/C/man5/core.5:113
3936 msgid "Naming of core dump files"
3940 #: build/C/man5/core.5:122
3942 "By default, a core dump file is named I<core>, but the "
3943 "I</proc/sys/kernel/core_pattern> file (since Linux 2.6 and 2.4.21) can be "
3944 "set to define a template that is used to name core dump files. The template "
3945 "can contain % specifiers which are substituted by the following values when "
3946 "a core file is created:"
3950 #: build/C/man5/core.5:125
3956 #: build/C/man5/core.5:128
3957 msgid "a single % character"
3961 #: build/C/man5/core.5:128
3967 #: build/C/man5/core.5:131
3968 msgid "PID of dumped process"
3972 #: build/C/man5/core.5:131
3978 #: build/C/man5/core.5:134
3979 msgid "(numeric) real UID of dumped process"
3983 #: build/C/man5/core.5:134
3989 #: build/C/man5/core.5:137
3990 msgid "(numeric) real GID of dumped process"
3994 #: build/C/man5/core.5:137
4000 #: build/C/man5/core.5:140
4001 msgid "number of signal causing dump"
4005 #: build/C/man5/core.5:140
4011 #: build/C/man5/core.5:144
4013 "time of dump, expressed as seconds since the Epoch, 1970-01-01 00:00:00 "
4018 #: build/C/man5/core.5:144
4024 #: build/C/man5/core.5:147
4025 msgid "hostname (same as I<nodename> returned by B<uname>(2))"
4029 #: build/C/man5/core.5:147
4035 #: build/C/man5/core.5:150
4036 msgid "executable filename (without path prefix)"
4040 #: build/C/man5/core.5:150
4046 #: build/C/man5/core.5:154
4048 "pathname of executable, with slashes (\\(aq/\\(aq) replaced by exclamation "
4049 "marks (\\(aq!\\(aq)."
4053 #: build/C/man5/core.5:154
4059 #: build/C/man5/core.5:157
4060 msgid "core file size soft resource limit of crashing process (since Linux 2.6.24)"
4064 #: build/C/man5/core.5:176
4066 "A single % at the end of the template is dropped from the core filename, as "
4067 "is the combination of a % followed by any character other than those listed "
4068 "above. All other characters in the template become a literal part of the "
4069 "core filename. The template may include \\(aq/\\(aq characters, which are "
4070 "interpreted as delimiters for directory names. The maximum size of the "
4071 "resulting core filename is 128 bytes (64 bytes in kernels before 2.6.19). "
4072 "The default value in this file is \"core\". For backward compatibility, if "
4073 "I</proc/sys/kernel/core_pattern> does not include \"%p\" and "
4074 "I</proc/sys/kernel/core_uses_pid> (see below) is nonzero, then .PID will be "
4075 "appended to the core filename."
4079 #: build/C/man5/core.5:187
4081 "Since version 2.4, Linux has also provided a more primitive method of "
4082 "controlling the name of the core dump file. If the "
4083 "I</proc/sys/kernel/core_uses_pid> file contains the value 0, then a core "
4084 "dump file is simply named I<core>. If this file contains a nonzero value, "
4085 "then the core dump file includes the process ID in a name of the form "
4089 #. 9520628e8ceb69fa9a4aee6b57f22675d9e1b709
4091 #: build/C/man5/core.5:194
4093 "Since Linux 3.6, if I</proc/sys/fs/suid_dumpable> is set to 2 "
4094 "(\"suidsafe\"), the pattern must be either an absolute pathname (starting "
4095 "with a leading \\(aq/\\(aq character) or a pipe, as defined below."
4099 #: build/C/man5/core.5:194
4101 msgid "Piping core dumps to a program"
4105 #: build/C/man5/core.5:204
4107 "Since kernel 2.6.19, Linux supports an alternate syntax for the "
4108 "I</proc/sys/kernel/core_pattern> file. If the first character of this file "
4109 "is a pipe symbol (B<|>), then the remainder of the line is interpreted as a "
4110 "program to be executed. Instead of being written to a disk file, the core "
4111 "dump is given as standard input to the program. Note the following points:"
4115 #: build/C/man5/core.5:208
4117 "The program must be specified using an absolute pathname (or a pathname "
4118 "relative to the root directory, I</>), and must immediately follow the '|' "
4123 #: build/C/man5/core.5:211
4124 msgid "The process created to run the program runs as user and group I<root>."
4128 #: build/C/man5/core.5:215
4130 "Command-line arguments can be supplied to the program (since Linux 2.6.24), "
4131 "delimited by white space (up to a total line length of 128 bytes)."
4135 #: build/C/man5/core.5:221
4137 "The command-line arguments can include any of the % specifiers listed "
4138 "above. For example, to pass the PID of the process that is being dumped, "
4139 "specify I<%p> in an argument."
4143 #: build/C/man5/core.5:221
4145 msgid "Controlling which mappings are written to the core dump"
4149 #: build/C/man5/core.5:227
4151 "Since kernel 2.6.23, the Linux-specific I</proc/PID/coredump_filter> file "
4152 "can be used to control which memory segments are written to the core dump "
4153 "file in the event that a core dump is performed for the process with the "
4154 "corresponding process ID."
4158 #: build/C/man5/core.5:233
4160 "The value in the file is a bit mask of memory mapping types (see "
4161 "B<mmap>(2)). If a bit is set in the mask, then memory mappings of the "
4162 "corresponding type are dumped; otherwise they are not dumped. The bits in "
4163 "this file have the following meanings:"
4167 #: build/C/man5/core.5:236
4173 #: build/C/man5/core.5:239
4174 msgid "Dump anonymous private mappings."
4178 #: build/C/man5/core.5:239
4184 #: build/C/man5/core.5:242
4185 msgid "Dump anonymous shared mappings."
4189 #: build/C/man5/core.5:242
4195 #: build/C/man5/core.5:245
4196 msgid "Dump file-backed private mappings."
4200 #: build/C/man5/core.5:245
4205 #. file-backed shared mappings of course also update the underlying
4208 #: build/C/man5/core.5:250
4209 msgid "Dump file-backed shared mappings."
4213 #: build/C/man5/core.5:250
4215 msgid "bit 4 (since Linux 2.6.24)"
4219 #: build/C/man5/core.5:253
4220 msgid "Dump ELF headers."
4224 #: build/C/man5/core.5:253
4226 msgid "bit 5 (since Linux 2.6.28)"
4230 #: build/C/man5/core.5:256
4231 msgid "Dump private huge pages."
4235 #: build/C/man5/core.5:256
4237 msgid "bit 6 (since Linux 2.6.28)"
4241 #: build/C/man5/core.5:259
4242 msgid "Dump shared huge pages."
4246 #: build/C/man5/core.5:267
4248 "By default, the following bits are set: 0, 1, 4 (if the "
4249 "B<CONFIG_CORE_DUMP_DEFAULT_ELF_HEADERS> kernel configuration option is "
4250 "enabled), and 5. The value of this file is displayed in hexadecimal. (The "
4251 "default value is thus displayed as 33.)"
4255 #: build/C/man5/core.5:272
4257 "Memory-mapped I/O pages such as frame buffer are never dumped, and virtual "
4258 "DSO pages are always dumped, regardless of the I<coredump_filter> value."
4262 #: build/C/man5/core.5:282
4264 "A child process created via B<fork>(2) inherits its parent's "
4265 "I<coredump_filter> value; the I<coredump_filter> value is preserved across "
4270 #: build/C/man5/core.5:286
4272 "It can be useful to set I<coredump_filter> in the parent shell before "
4273 "running a program, for example:"
4277 #: build/C/man5/core.5:291
4280 "$B< echo 0x7 E<gt> /proc/self/coredump_filter>\n"
4281 "$B< ./some_program>\n"
4285 #: build/C/man5/core.5:297
4287 "This file is provided only if the kernel was built with the "
4288 "B<CONFIG_ELF_CORE> configuration option."
4292 #: build/C/man5/core.5:302
4294 "The B<gdb>(1) I<gcore> command can be used to obtain a core dump of a "
4298 #. Changed with commit 6409324b385f3f63a03645b4422e3be67348d922
4299 #. Always including the PID in the name of the core file made
4300 #. sense for LinuxThreads, where each thread had a unique PID,
4301 #. but doesn't seem to serve any purpose with NPTL, where all the
4302 #. threads in a process share the same PID (as POSIX.1 requires).
4303 #. Probably the behavior is maintained so that applications using
4304 #. LinuxThreads continue appending the PID (the kernel has no easy
4305 #. way of telling which threading implementation the user-space
4306 #. application is using). -- mtk, April 2006
4308 #: build/C/man5/core.5:325
4310 "In Linux versions up to and including 2.6.27, if a multithreaded process "
4311 "(or, more precisely, a process that shares its memory with another process "
4312 "by being created with the B<CLONE_VM> flag of B<clone>(2)) dumps core, then "
4313 "the process ID is always appended to the core filename, unless the process "
4314 "ID was already included elsewhere in the filename via a %p specification in "
4315 "I</proc/sys/kernel/core_pattern>. (This is primarily useful when employing "
4316 "the obsolete LinuxThreads implementation, where each thread of a process has "
4321 #: build/C/man5/core.5:325 build/C/man3/gnu_get_libc_version.3:51 build/C/man3/stdarg.3:291 build/C/man4/vcs.4:101
4327 #: build/C/man5/core.5:333
4329 "The program below can be used to demonstrate the use of the pipe syntax in "
4330 "the I</proc/sys/kernel/core_pattern> file. The following shell session "
4331 "demonstrates the use of this program (compiled to create an executable named "
4332 "I<core_pattern_pipe_test>):"
4336 #: build/C/man5/core.5:354
4339 "$B< cc -o core_pattern_pipe_test core_pattern_pipe_test.c>\n"
4342 "#B< echo \"|$PWD/core_pattern_pipe_test %p UID=%u GID=%g sig=%s\" E<gt> "
4344 "B</proc/sys/kernel/core_pattern>\n"
4347 "B<^\\e> # type control-backslash\n"
4348 "Quit (core dumped)\n"
4349 "$B< cat core.info>\n"
4351 "argc[0]=E<lt>/home/mtk/core_pattern_pipe_testE<gt>\n"
4352 "argc[1]=E<lt>20575E<gt>\n"
4353 "argc[2]=E<lt>UID=1000E<gt>\n"
4354 "argc[3]=E<lt>GID=100E<gt>\n"
4355 "argc[4]=E<lt>sig=3E<gt>\n"
4356 "Total bytes in core dump: 282624\n"
4360 #: build/C/man5/core.5:356 build/C/man3/gnu_get_libc_version.3:61
4362 msgid "Program source"
4366 #: build/C/man5/core.5:360
4368 msgid "/* core_pattern_pipe_test.c */\n"
4372 #: build/C/man5/core.5:368
4375 "#define _GNU_SOURCE\n"
4376 "#include E<lt>sys/stat.hE<gt>\n"
4377 "#include E<lt>fcntl.hE<gt>\n"
4378 "#include E<lt>limits.hE<gt>\n"
4379 "#include E<lt>stdio.hE<gt>\n"
4380 "#include E<lt>stdlib.hE<gt>\n"
4381 "#include E<lt>unistd.hE<gt>\n"
4385 #: build/C/man5/core.5:370
4387 msgid "#define BUF_SIZE 1024\n"
4391 #: build/C/man5/core.5:379
4395 "main(int argc, char *argv[])\n"
4399 " char buf[BUF_SIZE];\n"
4401 " char cwd[PATH_MAX];\n"
4405 #: build/C/man5/core.5:382
4408 " /* Change our current working directory to that of the\n"
4409 " crashing process */\n"
4413 #: build/C/man5/core.5:385
4416 " snprintf(cwd, PATH_MAX, \"/proc/%s/cwd\", argv[1]);\n"
4421 #: build/C/man5/core.5:387
4423 msgid " /* Write output to file \"core.info\" in that directory */\n"
4427 #: build/C/man5/core.5:391
4430 " fp = fopen(\"core.info\", \"w+\");\n"
4431 " if (fp == NULL)\n"
4432 " exit(EXIT_FAILURE);\n"
4436 #: build/C/man5/core.5:394
4439 " /* Display command-line arguments given to core_pattern\n"
4440 " pipe program */\n"
4444 #: build/C/man5/core.5:398
4447 " fprintf(fp, \"argc=%d\\en\", argc);\n"
4448 " for (j = 0; j E<lt> argc; j++)\n"
4449 " fprintf(fp, \"argc[%d]=E<lt>%sE<gt>\\en\", j, argv[j]);\n"
4453 #: build/C/man5/core.5:400
4455 msgid " /* Count bytes in standard input (the core dump) */\n"
4459 #: build/C/man5/core.5:405
4463 " while ((nread = read(STDIN_FILENO, buf, BUF_SIZE)) E<gt> 0)\n"
4465 " fprintf(fp, \"Total bytes in core dump: %d\\en\", tot);\n"
4469 #: build/C/man5/core.5:408
4472 " exit(EXIT_SUCCESS);\n"
4477 #: build/C/man5/core.5:420
4479 "B<bash>(1), B<gdb>(1), B<getrlimit>(2), B<mmap>(2), B<prctl>(2), "
4480 "B<sigaction>(2), B<elf>(5), B<proc>(5), B<pthreads>(7), B<signal>(7)"
4484 #: build/C/man4/cpuid.4:26
4490 #: build/C/man4/cpuid.4:26 build/C/man4/msr.4:26
4496 #: build/C/man4/cpuid.4:29
4497 msgid "cpuid - x86 CPUID access device"
4501 #: build/C/man4/cpuid.4:31
4502 msgid "CPUID provides an interface for querying information about the x86 CPU."
4506 #: build/C/man4/cpuid.4:38
4508 "This device is accessed by B<lseek>(2) or B<pread>(2) to the appropriate "
4509 "CPUID level and reading in chunks of 16 bytes. A larger read size means "
4510 "multiple reads of consecutive levels."
4514 #: build/C/man4/cpuid.4:47
4516 "The lower 32 bits of the file position is used as the incoming I<%eax>, and "
4517 "the upper 32 bits of the file position as the incoming I<%ecx>, the latter "
4518 "intended for \"counting\" I<eax> levels like I<eax=4>."
4522 #: build/C/man4/cpuid.4:57
4524 "This driver uses I</dev/cpu/CPUNUM/cpuid>, where I<CPUNUM> is the minor "
4525 "number, and on an SMP box will direct the access to CPU I<CPUNUM> as listed "
4526 "in I</proc/cpuinfo>."
4530 #: build/C/man4/cpuid.4:62
4532 "This file is protected so that it can be read only by the user I<root>, or "
4533 "members of the group I<root>."
4537 #: build/C/man4/cpuid.4:67
4539 "The CPUID instruction can be directly executed by a program using inline "
4540 "assembler. However this device allows convenient access to all CPUs without "
4541 "changing process affinity."
4545 #: build/C/man4/cpuid.4:76
4547 "Most of the information in I<cpuid> is reported by the kernel in cooked form "
4548 "either in I</proc/cpuinfo> or through subdirectories in "
4549 "I</sys/devices/system/cpu>. Direct CPUID access through this device should "
4550 "only be used in exceptional cases."
4554 #: build/C/man4/cpuid.4:82
4556 "The I<cpuid> driver is not auto-loaded. On modular kernels you might need "
4557 "to use the following command to load it explicitly before use:"
4561 #: build/C/man4/cpuid.4:84
4563 msgid " $ I<modprobe cpuid>\n"
4567 #: build/C/man4/cpuid.4:87
4569 "There is no support for CPUID functions that require additional input "
4574 #: build/C/man4/cpuid.4:89
4575 msgid "Very old x86 CPUs don't support CPUID."
4579 #: build/C/man4/cpuid.4:93
4581 "Intel Corporation, Intel 64 and IA-32 Architectures Software Developer's "
4582 "Manual Volume 2A: Instruction Set Reference, A-M, 3-180 CPUID reference."
4586 #: build/C/man4/cpuid.4:96
4588 "Intel Corporation, Intel Processor Identification and the CPUID Instruction, "
4589 "Application note 485."
4593 #: build/C/man4/dsp56k.4:27
4599 #: build/C/man4/dsp56k.4:30
4600 msgid "dsp56k - DSP56001 interface device"
4604 #: build/C/man4/dsp56k.4:33
4606 msgid "#include E<lt>asm/dsp56k.hE<gt>\n"
4610 #: build/C/man4/dsp56k.4:36
4613 "B<ssize_t read(int >I<fd>B<, void *>I<data>B<, size_t >I<length>B<);>\n"
4614 "B<ssize_t write(int >I<fd>B<, void *>I<data>B<, size_t >I<length>B<);>\n"
4618 #: build/C/man4/dsp56k.4:42
4621 "B<int ioctl(int >I<fd>B<, DSP56K_UPLOAD, struct dsp56k_upload "
4622 "*>I<program>B<);>\n"
4623 "B<int ioctl(int >I<fd>B<, DSP56K_SET_TX_WSIZE, int >I<wsize>B<);>\n"
4624 "B<int ioctl(int >I<fd>B<, DSP56K_SET_RX_WSIZE, int >I<wsize>B<);>\n"
4625 "B<int ioctl(int >I<fd>B<, DSP56K_HOST_FLAGS, struct dsp56k_host_flags "
4627 "B<int ioctl(int >I<fd>B<, DSP56K_HOST_CMD, int >I<cmd>B<);>\n"
4631 #: build/C/man4/dsp56k.4:43 build/C/man4/fd.4:31 build/C/man4/full.4:29 build/C/man4/initrd.4:38 build/C/man4/lp.4:32 build/C/man4/mouse.4:29 build/C/man4/sd.4:34
4633 msgid "CONFIGURATION"
4637 #: build/C/man4/dsp56k.4:46
4639 "The dsp56k device is a character device with major number 55 and minor "
4644 #: build/C/man4/dsp56k.4:52
4646 "The Motorola DSP56001 is a fully programmable 24-bit digital signal "
4647 "processor found in Atari Falcon030-compatible computers. The I<dsp56k> "
4648 "special file is used to control the DSP56001, and to send and receive data "
4649 "using the bidirectional handshaked host port."
4653 #: build/C/man4/dsp56k.4:62
4655 "To send a data stream to the signal processor, use B<write>(2) to the "
4656 "device, and B<read>(2) to receive processed data. The data can be sent or "
4657 "received in 8, 16, 24, or 32-bit quantities on the host side, but will "
4658 "always be seen as 24-bit quantities in the DSP56001."
4662 #: build/C/man4/dsp56k.4:67
4663 msgid "The following B<ioctl>(2) calls are used to control the I<dsp56k> device:"
4667 #: build/C/man4/dsp56k.4:67
4669 msgid "B<DSP56K_UPLOAD>"
4673 #: build/C/man4/dsp56k.4:74
4675 "resets the DSP56001 and uploads a program. The third B<ioctl>(2) argument "
4676 "must be a pointer to a I<struct dsp56k_binary> with members I<bin> pointing "
4677 "to a DSP56001 binary program, and I<len> set to the length of the program, "
4678 "counted in 24-bit words."
4682 #: build/C/man4/dsp56k.4:74
4684 msgid "B<DSP56K_SET_TX_WSIZE>"
4688 #: build/C/man4/dsp56k.4:82
4690 "sets the transmit word size. Allowed values are in the range 1 to 4, and is "
4691 "the number of bytes that will be sent at a time to the DSP56001. These data "
4692 "quantities will either be padded with zero bytes, or truncated to fit the "
4693 "native 24-bit data format of the DSP56001."
4697 #: build/C/man4/dsp56k.4:82
4699 msgid "B<DSP56K_SET_RX_WSIZE>"
4703 #: build/C/man4/dsp56k.4:89
4705 "sets the receive word size. Allowed values are in the range 1 to 4, and is "
4706 "the number of bytes that will be received at a time from the DSP56001. "
4707 "These data quantities will either truncated, or padded with a null byte "
4708 "(\\(aq\\e0\\(aq) to fit the native 24-bit data format of the DSP56001."
4712 #: build/C/man4/dsp56k.4:89
4714 msgid "B<DSP56K_HOST_FLAGS>"
4718 #: build/C/man4/dsp56k.4:96
4720 "read and write the host flags. The host flags are four general-purpose bits "
4721 "that can be read by both the hosting computer and the DSP56001. Bits 0 and "
4722 "1 can be written by the host, and bits 2 and 3 can be written by the "
4727 #: build/C/man4/dsp56k.4:106
4729 "To access the host flags, the third B<ioctl>(2) argument must be a pointer "
4730 "to a I<struct dsp56k_host_flags>. If bit 0 or 1 is set in the I<dir> "
4731 "member, the corresponding bit in I<out> will be written to the host flags. "
4732 "The state of all host flags will be returned in the lower four bits of the "
4737 #: build/C/man4/dsp56k.4:106
4739 msgid "B<DSP56K_HOST_CMD>"
4743 #: build/C/man4/dsp56k.4:110
4745 "sends a host command. Allowed values are in the range 0 to 31, and is a "
4746 "user-defined command handled by the program running in the DSP56001."
4750 #. Fredrik Noring <noring@nocrew.org>, lars brinkhoff <lars@nocrew.org>,
4751 #. Tomas Berndtsson <tomas@nocrew.org>.
4753 #: build/C/man4/dsp56k.4:115
4758 #: build/C/man4/dsp56k.4:121
4760 "I<linux/include/asm-m68k/dsp56k.h>, I<linux/drivers/char/dsp56k.c>, E<.UR "
4761 "http://dsp56k.nocrew.org/> E<.UE ,> DSP56000/DSP56001 Digital Signal "
4762 "Processor User's Manual"
4766 #: build/C/man4/fd.4:28
4772 #: build/C/man4/fd.4:28
4778 #: build/C/man4/fd.4:31
4779 msgid "fd - floppy disk device"
4783 #: build/C/man4/fd.4:48
4785 "Floppy drives are block devices with major number 2. Typically they are "
4786 "owned by I<root.floppy> (i.e., user root, group floppy) and have either mode "
4787 "0660 (access checking via group membership) or mode 0666 (everybody has "
4788 "access). The minor numbers encode the device type, drive number, and "
4789 "controller number. For each device type (that is, combination of density "
4790 "and track count) there is a base minor number. To this base number, add "
4791 "the drive's number on its controller and 128 if the drive is on the "
4792 "secondary controller. In the following device tables, I<n> represents the "
4797 #: build/C/man4/fd.4:55
4799 "B<Warning: If you use formats with more tracks than supported by your drive, "
4800 "you may cause it mechanical damage.> Trying once if more tracks than the "
4801 "usual 40/80 are supported should not damage it, but no warranty is given for "
4802 "that. If you are not sure, don't create device entries for those formats, "
4803 "so as to prevent their usage."
4807 #: build/C/man4/fd.4:58
4809 "Drive-independent device files which automatically detect the media format "
4814 #: build/C/man4/fd.4:60
4816 msgid "Name\tBase minor #\n"
4820 #: build/C/man4/fd.4:61 build/C/man4/fd.4:69 build/C/man4/fd.4:77 build/C/man4/fd.4:93 build/C/man4/fd.4:105 build/C/man4/fd.4:124
4826 #: build/C/man4/fd.4:62
4828 msgid "B<fd>I<n>\t0\n"
4832 #: build/C/man4/fd.4:66
4833 msgid "5.25 inch double density device files:"
4837 #: build/C/man4/fd.4:68 build/C/man4/fd.4:76 build/C/man4/fd.4:92 build/C/man4/fd.4:104 build/C/man4/fd.4:123
4839 msgid "Name\tCapac.\tCyl.\tSect.\tHeads\tBase minor #\n"
4843 #: build/C/man4/fd.4:70
4845 msgid "B<fd>I<n>B<d360>\t360K\t40\t9\t2\t4\n"
4849 #: build/C/man4/fd.4:74
4850 msgid "5.25 inch high density device files:"
4854 #: build/C/man4/fd.4:78
4856 msgid "B<fd>I<n>B<h360>\t360K\t40\t9\t2\t20\n"
4860 #: build/C/man4/fd.4:79
4862 msgid "B<fd>I<n>B<h410>\t410K\t41\t10\t2\t48\n"
4866 #: build/C/man4/fd.4:80
4868 msgid "B<fd>I<n>B<h420>\t420K\t42\t10\t2\t64\n"
4872 #: build/C/man4/fd.4:81
4874 msgid "B<fd>I<n>B<h720>\t720K\t80\t9\t2\t24\n"
4878 #: build/C/man4/fd.4:82
4880 msgid "B<fd>I<n>B<h880>\t880K\t80\t11\t2\t80\n"
4884 #: build/C/man4/fd.4:83
4886 msgid "B<fd>I<n>B<h1200>\t1200K\t80\t15\t2\t8\n"
4890 #: build/C/man4/fd.4:84
4892 msgid "B<fd>I<n>B<h1440>\t1440K\t80\t18\t2\t40\n"
4896 #: build/C/man4/fd.4:85
4898 msgid "B<fd>I<n>B<h1476>\t1476K\t82\t18\t2\t56\n"
4902 #: build/C/man4/fd.4:86
4904 msgid "B<fd>I<n>B<h1494>\t1494K\t83\t18\t2\t72\n"
4908 #: build/C/man4/fd.4:87
4910 msgid "B<fd>I<n>B<h1600>\t1600K\t80\t20\t2\t92\n"
4914 #: build/C/man4/fd.4:90
4915 msgid "3.5 inch double density device files:"
4919 #: build/C/man4/fd.4:94
4921 msgid "B<fd>I<n>B<D360>\t360K\t80\t9\t1\t12\n"
4925 #: build/C/man4/fd.4:95
4927 msgid "B<fd>I<n>B<D720>\t720K\t80\t9\t2\t16\n"
4931 #: build/C/man4/fd.4:96
4933 msgid "B<fd>I<n>B<D800>\t800K\t80\t10\t2\t120\n"
4937 #: build/C/man4/fd.4:97
4939 msgid "B<fd>I<n>B<D1040>\t1040K\t80\t13\t2\t84\n"
4943 #: build/C/man4/fd.4:98
4945 msgid "B<fd>I<n>B<D1120>\t1120K\t80\t14\t2\t88\n"
4949 #: build/C/man4/fd.4:102
4950 msgid "3.5 inch high density device files:"
4954 #: build/C/man4/fd.4:106
4956 msgid "B<fd>I<n>B<H360>\t360K\t40\t9\t2\t12\n"
4960 #: build/C/man4/fd.4:107
4962 msgid "B<fd>I<n>B<H720>\t720K\t80\t9\t2\t16\n"
4966 #: build/C/man4/fd.4:108
4968 msgid "B<fd>I<n>B<H820>\t820K\t82\t10\t2\t52\n"
4972 #: build/C/man4/fd.4:109
4974 msgid "B<fd>I<n>B<H830>\t830K\t83\t10\t2\t68\n"
4978 #: build/C/man4/fd.4:110
4980 msgid "B<fd>I<n>B<H1440>\t1440K\t80\t18\t2\t28\n"
4984 #: build/C/man4/fd.4:111
4986 msgid "B<fd>I<n>B<H1600>\t1600K\t80\t20\t2\t124\n"
4990 #: build/C/man4/fd.4:112
4992 msgid "B<fd>I<n>B<H1680>\t1680K\t80\t21\t2\t44\n"
4996 #: build/C/man4/fd.4:113
4998 msgid "B<fd>I<n>B<H1722>\t1722K\t82\t21\t2\t60\n"
5002 #: build/C/man4/fd.4:114
5004 msgid "B<fd>I<n>B<H1743>\t1743K\t83\t21\t2\t76\n"
5008 #: build/C/man4/fd.4:115
5010 msgid "B<fd>I<n>B<H1760>\t1760K\t80\t22\t2\t96\n"
5014 #: build/C/man4/fd.4:116
5016 msgid "B<fd>I<n>B<H1840>\t1840K\t80\t23\t2\t116\n"
5020 #: build/C/man4/fd.4:117
5022 msgid "B<fd>I<n>B<H1920>\t1920K\t80\t24\t2\t100\n"
5026 #: build/C/man4/fd.4:121
5027 msgid "3.5 inch extra density device files:"
5031 #: build/C/man4/fd.4:125
5033 msgid "B<fd>I<n>B<E2880>\t2880K\t80\t36\t2\t32\n"
5037 #: build/C/man4/fd.4:126
5039 msgid "B<fd>I<n>B<CompaQ>\t2880K\t80\t36\t2\t36\n"
5043 #: build/C/man4/fd.4:127
5045 msgid "B<fd>I<n>B<E3200>\t3200K\t80\t40\t2\t104\n"
5049 #: build/C/man4/fd.4:128
5051 msgid "B<fd>I<n>B<E3520>\t3520K\t80\t44\t2\t108\n"
5055 #: build/C/man4/fd.4:129
5057 msgid "B<fd>I<n>B<E3840>\t3840K\t80\t48\t2\t112\n"
5061 #: build/C/man4/fd.4:136
5063 "B<fd> special files access the floppy disk drives in raw mode. The "
5064 "following B<ioctl>(2) calls are supported by B<fd> devices:"
5068 #: build/C/man4/fd.4:136
5074 #: build/C/man4/fd.4:138
5075 msgid "clears the media information of a drive (geometry of disk in drive)."
5079 #: build/C/man4/fd.4:138
5085 #: build/C/man4/fd.4:142
5087 "sets the media information of a drive. The media information will be lost "
5088 "when the media is changed."
5092 #: build/C/man4/fd.4:142
5098 #: build/C/man4/fd.4:148
5100 "sets the media information of a drive (geometry of disk in drive). The "
5101 "media information will not be lost when the media is changed. This will "
5102 "disable autodetection. In order to reenable autodetection, you have to "
5103 "issue an B<FDCLRPRM>."
5107 #: build/C/man4/fd.4:148 build/C/man4/fd.4:160
5109 msgid "B<FDGETDRVTYP>"
5113 #: build/C/man4/fd.4:153
5115 "returns the type of a drive (name parameter). For formats which work in "
5116 "several drive types, B<FDGETDRVTYP> returns a name which is appropriate for "
5117 "the oldest drive type which supports this format."
5121 #: build/C/man4/fd.4:153
5127 #: build/C/man4/fd.4:155
5128 msgid "invalidates the buffer cache for the given drive."
5132 #: build/C/man4/fd.4:155 build/C/man4/fd.4:158
5134 msgid "B<FDSETMAXERRS>"
5138 #: build/C/man4/fd.4:158
5140 "sets the error thresholds for reporting errors, aborting the operation, "
5141 "recalibrating, resetting, and reading sector by sector."
5145 #: build/C/man4/fd.4:160
5146 msgid "gets the current error thresholds."
5150 #: build/C/man4/fd.4:162
5151 msgid "gets the internal name of the drive."
5155 #: build/C/man4/fd.4:162
5157 msgid "B<FDWERRORCLR>"
5161 #: build/C/man4/fd.4:164
5162 msgid "clears the write error statistics."
5166 #: build/C/man4/fd.4:164
5168 msgid "B<FDWERRORGET>"
5172 #: build/C/man4/fd.4:171
5174 "reads the write error statistics. These include the total number of write "
5175 "errors, the location and disk of the first write error, and the location and "
5176 "disk of the last write error. Disks are identified by a generation number "
5177 "which is incremented at (almost) each disk change."
5181 #: build/C/man4/fd.4:171
5183 msgid "B<FDTWADDLE>"
5187 #: build/C/man4/fd.4:175
5189 "Switch the drive motor off for a few microseconds. This might be needed in "
5190 "order to access a disk whose sectors are too close together."
5194 #: build/C/man4/fd.4:175
5196 msgid "B<FDSETDRVPRM>"
5200 #: build/C/man4/fd.4:177
5201 msgid "sets various drive parameters."
5205 #: build/C/man4/fd.4:177
5207 msgid "B<FDGETDRVPRM>"
5211 #: build/C/man4/fd.4:179
5212 msgid "reads these parameters back."
5216 #: build/C/man4/fd.4:179
5218 msgid "B<FDGETDRVSTAT>"
5222 #: build/C/man4/fd.4:181
5223 msgid "gets the cached drive state (disk changed, write protected et al.)"
5227 #: build/C/man4/fd.4:181
5229 msgid "B<FDPOLLDRVSTAT>"
5233 #: build/C/man4/fd.4:183
5234 msgid "polls the drive and return its state."
5238 #: build/C/man4/fd.4:183
5240 msgid "B<FDGETFDCSTAT>"
5244 #: build/C/man4/fd.4:185
5245 msgid "gets the floppy controller state."
5249 #: build/C/man4/fd.4:185
5255 #: build/C/man4/fd.4:187
5256 msgid "resets the floppy controller under certain conditions."
5260 #: build/C/man4/fd.4:187
5266 #: build/C/man4/fd.4:189
5267 msgid "sends a raw command to the floppy controller."
5271 #: build/C/man4/fd.4:194
5273 "For more precise information, consult also the I<E<lt>linux/fd.hE<gt>> and "
5274 "I<E<lt>linux/fdreg.hE<gt>> include files, as well as the B<floppycontrol>(1) "
5279 #: build/C/man4/fd.4:196
5284 #: build/C/man4/fd.4:202
5286 "The various formats permit reading and writing many types of disks. "
5287 "However, if a floppy is formatted with an inter-sector gap that is too "
5288 "small, performance may drop, to the point of needing a few seconds to access "
5289 "an entire track. To prevent this, use interleaved formats."
5293 #: build/C/man4/fd.4:206
5295 "It is not possible to read floppies which are formatted using GCR (group "
5296 "code recording), which is used by Apple II and Macintosh computers (800k "
5301 #. Alain Knaff (Alain.Knaff@imag.fr), David Niemi
5302 #. (niemidc@clark.net), Bill Broadhurst (bbroad@netcom.com).
5304 #: build/C/man4/fd.4:213
5306 "Reading floppies which are hard sectored (one hole per sector, with the "
5307 "index hole being a little skewed) is not supported. This used to be common "
5308 "with older 8-inch floppies."
5312 #: build/C/man4/fd.4:221
5314 "B<chown>(1), B<floppycontrol>(1), B<getfdprm>(1), B<mknod>(1), "
5315 "B<superformat>(1), B<mount>(8), B<setfdprm>(8)"
5319 #: build/C/man7/fifo.7:13
5325 #: build/C/man7/fifo.7:13
5331 #: build/C/man7/fifo.7:16
5332 msgid "fifo - first-in first-out special file, named pipe"
5336 #: build/C/man7/fifo.7:28
5338 "A FIFO special file (a named pipe) is similar to a pipe, except that it is "
5339 "accessed as part of the filesystem. It can be opened by multiple processes "
5340 "for reading or writing. When processes are exchanging data via the FIFO, "
5341 "the kernel passes all data internally without writing it to the filesystem. "
5342 "Thus, the FIFO special file has no contents on the filesystem; the "
5343 "filesystem entry merely serves as a reference point so that processes can "
5344 "access the pipe using a name in the filesystem."
5348 #: build/C/man7/fifo.7:35
5350 "The kernel maintains exactly one pipe object for each FIFO special file that "
5351 "is opened by at least one process. The FIFO must be opened on both ends "
5352 "(reading and writing) before data can be passed. Normally, opening the "
5353 "FIFO blocks until the other end is opened also."
5357 #: build/C/man7/fifo.7:44
5359 "A process can open a FIFO in nonblocking mode. In this case, opening for "
5360 "read-only will succeed even if no-one has opened on the write side yet, "
5361 "opening for write-only will fail with B<ENXIO> (no such device or address) "
5362 "unless the other end has already been opened."
5366 #: build/C/man7/fifo.7:54
5368 "Under Linux, opening a FIFO for read and write will succeed both in blocking "
5369 "and nonblocking mode. POSIX leaves this behavior undefined. This can be "
5370 "used to open a FIFO for writing while there are no readers available. A "
5371 "process that uses both ends of the connection in order to communicate with "
5372 "itself should be very careful to avoid deadlocks."
5376 #: build/C/man7/fifo.7:59
5378 "When a process tries to write to a FIFO that is not opened for read on the "
5379 "other side, the process is sent a B<SIGPIPE> signal."
5383 #: build/C/man7/fifo.7:65
5385 "FIFO special files can be created by B<mkfifo>(3), and are indicated by I<ls "
5386 "-l> with the file type \\(aqp\\(aq."
5390 #: build/C/man7/fifo.7:74
5392 "B<mkfifo>(1), B<open>(2), B<pipe>(2), B<sigaction>(2), B<signal>(2), "
5393 "B<socketpair>(2), B<mkfifo>(3), B<pipe>(7)"
5397 #: build/C/man4/full.4:26
5403 #: build/C/man4/full.4:26
5409 #: build/C/man4/full.4:29
5410 msgid "full - always full device"
5414 #: build/C/man4/full.4:34
5416 "If your system does not have I</dev/full> created already, it can be created "
5417 "with the following commands:"
5421 #: build/C/man4/full.4:38
5424 " mknod -m 666 /dev/full c 1 7\n"
5425 " chown root:root /dev/full\n"
5429 #: build/C/man4/full.4:44
5430 msgid "File I</dev/full> has major device number 1 and minor device number 7."
5434 #: build/C/man4/full.4:51
5436 "Writes to the I</dev/full> device will fail with an B<ENOSPC> error. This "
5437 "can be used to test how a program handles disk-full errors."
5441 #: build/C/man4/full.4:55
5442 msgid "Reads from the I</dev/full> device will return \\e0 characters."
5446 #: build/C/man4/full.4:59
5447 msgid "Seeks on I</dev/full> will always succeed."
5451 #: build/C/man4/full.4:61
5456 #: build/C/man4/full.4:65
5457 msgid "B<mknod>(1), B<null>(4), B<zero>(4)"
5461 #: build/C/man3/gnu_get_libc_version.3:26
5463 msgid "GNU_GET_LIBC_VERSION"
5467 #: build/C/man3/gnu_get_libc_version.3:26
5473 #: build/C/man3/gnu_get_libc_version.3:29
5474 msgid "gnu_get_libc_version, gnu_get_libc_release - get glibc version and release"
5478 #: build/C/man3/gnu_get_libc_version.3:32
5480 msgid "B<#include E<lt>gnu/libc-version.hE<gt>>\n"
5484 #: build/C/man3/gnu_get_libc_version.3:35
5487 "B<const char *gnu_get_libc_version(void);>\n"
5488 "B<const char *gnu_get_libc_release(void);>\n"
5492 #: build/C/man3/gnu_get_libc_version.3:40
5494 "The function B<gnu_get_libc_version>() returns a string that identifies the "
5495 "glibc version available on the system."
5499 #: build/C/man3/gnu_get_libc_version.3:47
5501 "The function B<gnu_get_libc_release>() returns a string indicates the "
5502 "release status of the glibc version available on the system. This will be a "
5503 "string such as I<stable>."
5507 #: build/C/man3/gnu_get_libc_version.3:47 build/C/man4/vcs.4:99
5513 #: build/C/man3/gnu_get_libc_version.3:49
5514 msgid "These functions first appeared in glibc in version 2.1."
5518 #: build/C/man3/gnu_get_libc_version.3:49 build/C/man3/makedev.3:62 build/C/man3/mkfifo.3:104 build/C/man2/mknod.2:177 build/C/man3/setlogmask.3:75 build/C/man3/stdarg.3:229 build/C/man2/syslog.2:298 build/C/man3/syslog.3:252 build/C/man7/uri.7:584
5520 msgid "CONFORMING TO"
5524 #: build/C/man3/gnu_get_libc_version.3:51
5525 msgid "These functions are glibc-specific."
5529 #: build/C/man3/gnu_get_libc_version.3:53
5530 msgid "When run, the program below will produce output such as the following:"
5534 #: build/C/man3/gnu_get_libc_version.3:59
5538 "GNU libc version: 2.8\n"
5539 "GNU libc release: stable\n"
5543 #: build/C/man3/gnu_get_libc_version.3:67
5546 "#include E<lt>gnu/libc-version.hE<gt>\n"
5547 "#include E<lt>stdlib.hE<gt>\n"
5548 "#include E<lt>stdio.hE<gt>\n"
5552 #: build/C/man3/gnu_get_libc_version.3:75
5556 "main(int argc, char *argv[])\n"
5558 " printf(\"GNU libc version: %s\\en\", gnu_get_libc_version());\n"
5559 " printf(\"GNU libc release: %s\\en\", gnu_get_libc_release());\n"
5560 " exit(EXIT_SUCCESS);\n"
5565 #: build/C/man3/gnu_get_libc_version.3:78
5566 msgid "B<confstr>(3)"
5570 #: build/C/man4/hd.4:29
5576 #: build/C/man4/hd.4:29
5582 #: build/C/man4/hd.4:32
5583 msgid "hd - MFM/IDE hard disk devices"
5587 #: build/C/man4/hd.4:47
5589 "The B<hd*> devices are block devices to access MFM/IDE hard disk drives in "
5590 "raw mode. The master drive on the primary IDE controller (major device "
5591 "number 3) is B<hda>; the slave drive is B<hdb>. The master drive of the "
5592 "second controller (major device number 22) is B<hdc> and the slave B<hdd>."
5596 #: build/C/man4/hd.4:71
5598 "General IDE block device names have the form B<hd>I<X>, or B<hd>I<XP>, where "
5599 "I<X> is a letter denoting the physical drive, and I<P> is a number denoting "
5600 "the partition on that physical drive. The first form, B<hd>I<X,> is used to "
5601 "address the whole drive. Partition numbers are assigned in the order the "
5602 "partitions are discovered, and only nonempty, nonextended partitions get a "
5603 "number. However, partition numbers 1-4 are given to the four partitions "
5604 "described in the MBR (the \"primary\" partitions), regardless of whether "
5605 "they are unused or extended. Thus, the first logical partition will be "
5606 "B<hd>I<X>B<5>\\&. Both DOS-type partitioning and BSD-disklabel partitioning "
5607 "are supported. You can have at most 63 partitions on an IDE disk."
5611 #: build/C/man4/hd.4:77
5613 "For example, I</dev/hda> refers to all of the first IDE drive in the system; "
5614 "and I</dev/hdb3> refers to the third DOS \"primary\" partition on the second "
5619 #: build/C/man4/hd.4:79 build/C/man4/ttyS.4:34
5620 msgid "They are typically created by:"
5624 #: build/C/man4/hd.4:82
5625 msgid "mknod -m 660 /dev/hda b 3 0"
5629 #: build/C/man4/hd.4:84
5630 msgid "mknod -m 660 /dev/hda1 b 3 1"
5634 #: build/C/man4/hd.4:86
5635 msgid "mknod -m 660 /dev/hda2 b 3 2"
5639 #: build/C/man4/hd.4:88 build/C/man4/hd.4:98
5644 #: build/C/man4/hd.4:90
5645 msgid "mknod -m 660 /dev/hda8 b 3 8"
5649 #: build/C/man4/hd.4:92
5650 msgid "mknod -m 660 /dev/hdb b 3 64"
5654 #: build/C/man4/hd.4:94
5655 msgid "mknod -m 660 /dev/hdb1 b 3 65"
5659 #: build/C/man4/hd.4:96
5660 msgid "mknod -m 660 /dev/hdb2 b 3 66"
5664 #: build/C/man4/hd.4:100
5665 msgid "mknod -m 660 /dev/hdb8 b 3 72"
5669 #: build/C/man4/hd.4:102
5670 msgid "chown root:disk /dev/hd*"
5674 #: build/C/man4/hd.4:105
5679 #: build/C/man4/hd.4:110
5680 msgid "B<chown>(1), B<mknod>(1), B<sd>(4), B<mount>(8)"
5684 #: build/C/man4/hpsa.4:10
5690 #: build/C/man4/hpsa.4:13
5691 msgid "hpsa - HP Smart Array SCSI driver"
5695 #: build/C/man4/hpsa.4:16
5697 msgid "modprobe hpsa [ hpsa_allow_any=1 ]\n"
5701 #: build/C/man4/hpsa.4:20
5702 msgid "B<hpsa> is a SCSI driver for HP Smart Array RAID controllers."
5706 #: build/C/man4/hpsa.4:39
5708 "I<hpsa_allow_any=1>: This option allows the driver to attempt to operate on "
5709 "any HP Smart Array hardware RAID controller, even if it is not explicitly "
5710 "known to the driver. This allows newer hardware to work with older "
5711 "drivers. Typically this is used to allow installation of operating systems "
5712 "from media that predates the RAID controller, though it may also be used to "
5713 "enable B<hpsa> to drive older controllers that would normally be handled by "
5714 "the B<cciss>(4) driver. These older boards have not been tested and are "
5715 "not supported with B<hpsa>, and B<cciss>(4) should still be used for these."
5719 #: build/C/man4/hpsa.4:43
5720 msgid "The B<hpsa> driver supports the following Smart Array boards:"
5724 #: build/C/man4/hpsa.4:54
5727 " Smart Array P700M\n"
5728 " Smart Array P212\n"
5729 " Smart Array P410\n"
5730 " Smart Array P410i\n"
5731 " Smart Array P411\n"
5732 " Smart Array P812\n"
5733 " Smart Array P712m\n"
5734 " Smart Array P711m\n"
5735 " StorageWorks P1210m\n"
5739 #: build/C/man4/hpsa.4:78
5741 "Logical drives are accessed via the SCSI disk driver (B<sd>(4)), tape drives "
5742 "via the SCSI tape driver (B<st>(4)), and the RAID controller via the SCSI "
5743 "generic driver (B<sg>(4)), with device nodes named I</dev/sd*,> I</dev/st*>, "
5744 "and I</dev/sg*>, respectively."
5748 #: build/C/man4/hpsa.4:78
5750 msgid "HPSA-specific host attribute files in /sys"
5754 #: build/C/man4/hpsa.4:79
5756 msgid "I</sys/class/scsi_host/host*/rescan>"
5760 #: build/C/man4/hpsa.4:93
5762 "This is a write-only attribute. Writing to this attribute will cause the "
5763 "driver to scan for new, changed, or removed devices (e.g,. hot-plugged tape "
5764 "drives, or newly configured or deleted logical drives, etc.) and notify the "
5765 "SCSI midlayer of any changes detected. Normally a rescan is triggered "
5766 "automatically by HP's Array Configuration Utility (either the GUI or the "
5767 "command-line variety); thus, for logical drive changes, the user should not "
5768 "normally have to use this attribute. This attribute may be useful when hot "
5769 "plugging devices like tape drives, or entire storage boxes containing "
5770 "pre-configured logical drives."
5774 #: build/C/man4/hpsa.4:93
5776 msgid "I</sys/class/scsi_host/host*/firmware_revision>"
5780 #: build/C/man4/hpsa.4:96
5781 msgid "This attribute contains the firmware version of the Smart Array."
5785 #: build/C/man4/hpsa.4:98
5786 msgid "For example:"
5790 #: build/C/man4/hpsa.4:103
5793 " # B<cd /sys/class/scsi_host/host4>\n"
5794 " # B<cat firmware_revision>\n"
5799 #: build/C/man4/hpsa.4:104
5801 msgid "HPSA-specific disk attribute files in /sys"
5805 #: build/C/man4/hpsa.4:105
5807 msgid "I</sys/class/scsi_disk/c:b:t:l/device/unique_id>"
5811 #: build/C/man4/hpsa.4:108
5812 msgid "This attribute contains a 32 hex-digit unique ID for each logical drive."
5816 #: build/C/man4/hpsa.4:111 build/C/man4/hpsa.4:122 build/C/man4/hpsa.4:136
5818 msgid "For example:\n"
5822 #: build/C/man4/hpsa.4:115
5825 " # B<cd /sys/class/scsi_disk/4:0:0:0/device>\n"
5826 " # B<cat unique_id>\n"
5827 " 600508B1001044395355323037570F77\n"
5831 #: build/C/man4/hpsa.4:116
5833 msgid "I</sys/class/scsi_disk/c:b:t:l/device/raid_level>"
5837 #: build/C/man4/hpsa.4:119
5838 msgid "This attribute contains the RAID level of each logical drive."
5842 #: build/C/man4/hpsa.4:126
5845 " # B<cd /sys/class/scsi_disk/4:0:0:0/device>\n"
5846 " # B<cat raid_level>\n"
5851 #: build/C/man4/hpsa.4:127
5853 msgid "I</sys/class/scsi_disk/c:b:t:l/device/lunid>"
5857 #: build/C/man4/hpsa.4:133
5859 "This attribute contains the 16 hex-digit (8 byte) LUN ID by which a logical "
5860 "drive or physical device can be addressed. I<c>:I<b>:I<t>:I<l> are the "
5861 "controller, bus, target and lun of the device."
5865 #: build/C/man4/hpsa.4:140
5868 " # B<cd /sys/class/scsi_disk/4:0:0:0/device>\n"
5870 " 0x0000004000000000\n"
5874 #: build/C/man4/hpsa.4:141
5876 msgid "Supported ioctl() operations"
5880 #: build/C/man4/hpsa.4:153
5882 "For compatibility with applications written for the B<cciss>(4) driver, "
5883 "many, but not all of the ioctls supported by the B<cciss>(4) driver are "
5884 "also supported by the B<hpsa> driver. The data structures used by these "
5885 "ioctls are described in the Linux kernel source file "
5886 "I<include/linux/cciss_ioctl.h>."
5890 #: build/C/man4/hpsa.4:153
5892 msgid "B<CCISS_DEREGDISK>, B<CCISS_REGNEWDISK>, B<CCISS_REGNEWD>"
5896 #: build/C/man4/hpsa.4:159
5898 "These three ioctls all do exactly the same thing, which is to cause the "
5899 "driver to rescan for new devices. This does exactly the same thing as "
5900 "writing to the hpsa-specific host \"rescan\" attribute."
5904 #: build/C/man4/hpsa.4:159
5906 msgid "B<CCISS_GETPCIINFO>"
5910 #: build/C/man4/hpsa.4:162
5912 "Returns PCI domain, bus, device and function and \"board ID\" (PCI subsystem "
5917 #: build/C/man4/hpsa.4:162
5919 msgid "B<CCISS_GETDRIVVER>"
5923 #: build/C/man4/hpsa.4:165
5924 msgid "Returns driver version in three bytes encoded as:"
5928 #: build/C/man4/hpsa.4:168
5931 " (major_version E<lt>E<lt> 16) | (minor_version E<lt>E<lt> 8) |\n"
5932 " (subminor_version)\n"
5936 #: build/C/man4/hpsa.4:168
5938 msgid "B<CCISS_PASSTHRU>, B<CCISS_BIG_PASSTHRU>"
5942 #: build/C/man4/hpsa.4:179
5944 "Allows \"BMIC\" and \"CISS\" commands to be passed through to the Smart "
5945 "Array. These are used extensively by the HP Array Configuration Utility, "
5946 "SNMP storage agents, etc. See I<cciss_vol_status> at E<.UR "
5947 "http://cciss.sf.net> E<.UE> for some examples."
5951 #: build/C/man4/hpsa.4:186
5953 "B<cciss>(4), B<sd>(4), B<st>(4), B<cciss_vol_status>(8), B<hpacucli>(8), "
5958 #. Don Brace, Steve Cameron, Tom Lawler, Mike Miller, Scott Teel
5959 #. and probably some other people.
5961 #: build/C/man4/hpsa.4:197
5963 "E<.UR http://cciss.sf.net> E<.UE ,> and I<Documentation/scsi/hpsa.txt> and "
5964 "I<Documentation/ABI/testing/sysfs-bus-pci-devices-cciss> in the Linux kernel "
5969 #: build/C/man4/initrd.4:35
5975 #: build/C/man4/initrd.4:35 build/C/man4/st.4:25
5981 #: build/C/man4/initrd.4:38
5982 msgid "initrd - boot loader initialized RAM disk"
5986 #: build/C/man4/initrd.4:51
5988 "The I</dev/initrd> is a read-only block device assigned major number 1 and "
5989 "minor number 250. Typically I</dev/initrd> is owned by I<root.disk> with "
5990 "mode 0400 (read access by root only). If the Linux system does not have "
5991 "I</dev/initrd> already created, it can be created with the following "
5996 #: build/C/man4/initrd.4:56
6000 " mknod -m 400 /dev/initrd b 1 250\n"
6001 " chown root:disk /dev/initrd>\n"
6006 #: build/C/man4/initrd.4:71
6008 "Also, support for both \"RAM disk\" and \"Initial RAM disk\" (e.g., "
6009 "B<CONFIG_BLK_DEV_RAM=y> and B<CONFIG_BLK_DEV_INITRD=y>) must be compiled "
6010 "directly into the Linux kernel to use I</dev/initrd>. When using "
6011 "I</dev/initrd>, the RAM disk driver cannot be loaded as a module."
6015 #: build/C/man4/initrd.4:80
6017 "The special file I</dev/initrd> is a read-only block device. This device is "
6018 "a RAM disk that is initialized (e.g., loaded) by the boot loader before the "
6019 "kernel is started. The kernel then can use I</dev/initrd>'s contents for a "
6020 "two-phase system boot-up."
6024 #: build/C/man4/initrd.4:93
6026 "In the first boot-up phase, the kernel starts up and mounts an initial root "
6027 "filesystem from the contents of I</dev/initrd> (e.g., RAM disk initialized "
6028 "by the boot loader). In the second phase, additional drivers or other "
6029 "modules are loaded from the initial root device's contents. After loading "
6030 "the additional modules, a new root filesystem (i.e., the normal root "
6031 "filesystem) is mounted from a different device."
6035 #: build/C/man4/initrd.4:93
6037 msgid "Boot-up operation"
6041 #: build/C/man4/initrd.4:97
6042 msgid "When booting up with B<initrd>, the system boots as follows:"
6046 #: build/C/man4/initrd.4:101
6048 "The boot loader loads the kernel program and I</dev/initrd>'s contents into "
6053 #: build/C/man4/initrd.4:109
6055 "On kernel startup, the kernel uncompresses and copies the contents of the "
6056 "device I</dev/initrd> onto device I</dev/ram0> and then frees the memory "
6057 "used by I</dev/initrd>."
6061 #: build/C/man4/initrd.4:109 build/C/man4/initrd.4:339 build/C/man4/initrd.4:458 build/C/man4/st.4:919
6067 #: build/C/man4/initrd.4:113
6069 "The kernel then read-write mounts the device I</dev/ram0> as the initial "
6074 #: build/C/man4/initrd.4:113 build/C/man4/initrd.4:343 build/C/man4/st.4:926
6080 #: build/C/man4/initrd.4:118
6082 "If the indicated normal root filesystem is also the initial root filesystem "
6083 "(e.g., I</dev/ram0>) then the kernel skips to the last step for the usual "
6088 #: build/C/man4/initrd.4:118 build/C/man4/initrd.4:349 build/C/man4/st.4:931
6094 #: build/C/man4/initrd.4:130
6096 "If the executable file I</linuxrc> is present in the initial root "
6097 "filesystem, I</linuxrc> is executed with UID 0. (The file I</linuxrc> must "
6098 "have executable permission. The file I</linuxrc> can be any valid "
6099 "executable, including a shell script.)"
6103 #: build/C/man4/initrd.4:130 build/C/man4/initrd.4:358
6109 #: build/C/man4/initrd.4:142
6111 "If I</linuxrc> is not executed or when I</linuxrc> terminates, the normal "
6112 "root filesystem is mounted. (If I</linuxrc> exits with any filesystems "
6113 "mounted on the initial root filesystem, then the behavior of the kernel is "
6114 "B<UNSPECIFIED>. See the NOTES section for the current kernel behavior.)"
6118 #: build/C/man4/initrd.4:142 build/C/man4/initrd.4:360
6124 #: build/C/man4/initrd.4:173
6126 "If the normal root filesystem has a directory I</initrd>, the device "
6127 "I</dev/ram0> is moved from I</> to I</initrd>. Otherwise if the directory "
6128 "I</initrd> does not exist, the device I</dev/ram0> is unmounted. (When "
6129 "moved from I</> to I</initrd>, I</dev/ram0> is not unmounted and therefore "
6130 "processes can remain running from I</dev/ram0>. If directory I</initrd> "
6131 "does not exist on the normal root filesystem and any processes remain "
6132 "running from I</dev/ram0> when I</linuxrc> exits, the behavior of the kernel "
6133 "is B<UNSPECIFIED>. See the NOTES section for the current kernel behavior.)"
6137 #: build/C/man4/initrd.4:173 build/C/man4/initrd.4:363
6143 #: build/C/man4/initrd.4:180
6145 "The usual boot sequence (e.g., invocation of I</sbin/init>) is performed on "
6146 "the normal root filesystem."
6150 #: build/C/man4/initrd.4:184
6152 "The following boot loader options, when used with B<initrd>, affect the "
6153 "kernel's boot-up operation:"
6157 #: build/C/man4/initrd.4:184
6159 msgid "B<initrd=>I<filename>"
6163 #: build/C/man4/initrd.4:199
6165 "Specifies the file to load as the contents of I</dev/initrd>. For "
6166 "B<LOADLIN> this is a command-line option. For B<LILO> you have to use this "
6167 "command in the B<LILO> configuration file I</etc/lilo.config>. The filename "
6168 "specified with this option will typically be a gzipped filesystem image."
6172 #: build/C/man4/initrd.4:199
6178 #: build/C/man4/initrd.4:214
6180 "This boot option disables the two-phase boot-up operation. The kernel "
6181 "performs the usual boot sequence as if I</dev/initrd> was not initialized. "
6182 "With this option, any contents of I</dev/initrd> loaded into memory by the "
6183 "boot loader contents are preserved. This option permits the contents of "
6184 "I</dev/initrd> to be any data and need not be limited to a filesystem "
6185 "image. However, device I</dev/initrd> is read-only and can be read only one "
6186 "time after system startup."
6190 #: build/C/man4/initrd.4:214
6192 msgid "B<root=>I<device-name>"
6196 #: build/C/man4/initrd.4:232
6198 "Specifies the device to be used as the normal root filesystem. For "
6199 "B<LOADLIN> this is a command-line option. For B<LILO> this is a boot time "
6200 "option or can be used as an option line in the B<LILO> configuration file "
6201 "I</etc/lilo.config>. The device specified by the this option must be a "
6202 "mountable device having a suitable root filesystem."
6206 #: build/C/man4/initrd.4:232
6208 msgid "Changing the normal root filesystem"
6212 #: build/C/man4/initrd.4:252
6214 "By default, the kernel's settings (e.g., set in the kernel file with "
6215 "B<rdev>(8) or compiled into the kernel file), or the boot loader option "
6216 "setting is used for the normal root filesystems. For an NFS-mounted normal "
6217 "root filesystem, one has to use the B<nfs_root_name> and B<nfs_root_addrs> "
6218 "boot options to give the NFS settings. For more information on NFS-mounted "
6219 "root see the kernel documentation file "
6220 "B<Documentation/filesystems/nfsroot.txt>. For more information on setting "
6221 "the root filesystem see also the B<LILO> and B<LOADLIN> documentation."
6225 #: build/C/man4/initrd.4:284
6227 "It is also possible for the I</linuxrc> executable to change the normal root "
6228 "device. For I</linuxrc> to change the normal root device, I</proc> must be "
6229 "mounted. After mounting I</proc>, I</linuxrc> changes the normal root "
6230 "device by writing into the proc files I</proc/sys/kernel/real-root-dev>, "
6231 "I</proc/sys/kernel/nfs-root-name>, and I</proc/sys/kernel/nfs-root-addrs>. "
6232 "For a physical root device, the root device is changed by having I</linuxrc> "
6233 "write the new root filesystem device number into "
6234 "I</proc/sys/kernel/real-root-dev>. For an NFS root filesystem, the root "
6235 "device is changed by having I</linuxrc> write the NFS setting into files "
6236 "I</proc/sys/kernel/nfs-root-name> and I</proc/sys/kernel/nfs-root-addrs> and "
6237 "then writing 0xff (e.g., the pseudo-NFS-device number) into file "
6238 "I</proc/sys/kernel/real-root-dev>. For example, the following shell command "
6239 "line would change the normal root device to I</dev/hdb1>:"
6243 #: build/C/man4/initrd.4:287
6245 msgid " echo 0x365 E<gt>/proc/sys/kernel/real-root-dev\n"
6249 #: build/C/man4/initrd.4:294
6251 "For an NFS example, the following shell command lines would change the "
6252 "normal root device to the NFS directory I</var/nfsroot> on a local networked "
6253 "NFS server with IP number 193.8.232.7 for a system with IP number "
6254 "193.8.232.2 and named \"idefix\":"
6258 #: build/C/man4/initrd.4:300
6261 " echo /var/nfsroot E<gt>/proc/sys/kernel/nfs-root-name\n"
6262 " echo 193.8.232.2:193.8.232.7::255.255.255.0:idefix \\e\n"
6263 " E<gt>/proc/sys/kernel/nfs-root-addrs\n"
6264 " echo 255 E<gt>/proc/sys/kernel/real-root-dev\n"
6267 #. FIXME the manual page should describe the pivot_root mechanism.
6269 #: build/C/man4/initrd.4:317
6271 "B<Note>: The use of I</proc/sys/kernel/real-root-dev> to change the root "
6272 "filesystem is obsolete. See the Linux kernel source file "
6273 "I<Documentation/initrd.txt> as well as B<pivot_root>(2) and "
6274 "B<pivot_root>(8) for information on the modern method of changing the root "
6279 #: build/C/man4/initrd.4:317 build/C/man4/random.4:65 build/C/man7/uri.7:109
6285 #: build/C/man4/initrd.4:321
6287 "The main motivation for implementing B<initrd> was to allow for modular "
6288 "kernel configuration at system installation."
6292 #: build/C/man4/initrd.4:323
6293 msgid "A possible system installation scenario is as follows:"
6297 #: build/C/man4/initrd.4:331
6299 "The loader program boots from floppy or other media with a minimal kernel "
6300 "(e.g., support for I</dev/ram>, I</dev/initrd>, and the ext2 filesystem) and "
6301 "loads I</dev/initrd> with a gzipped version of the initial filesystem."
6305 #: build/C/man4/initrd.4:339
6307 "The executable I</linuxrc> determines what is needed to (1) mount the normal "
6308 "root filesystem (i.e., device type, device drivers, filesystem) and (2) the "
6309 "distribution media (e.g., CD-ROM, network, tape, ...). This can be done by "
6310 "asking the user, by auto-probing, or by using a hybrid approach."
6314 #: build/C/man4/initrd.4:343
6316 "The executable I</linuxrc> loads the necessary modules from the initial root "
6321 #: build/C/man4/initrd.4:349
6323 "The executable I</linuxrc> creates and populates the root filesystem. (At "
6324 "this stage the normal root filesystem does not have to be a completed system "
6329 #: build/C/man4/initrd.4:358
6331 "The executable I</linuxrc> sets I</proc/sys/kernel/real-root-dev>, unmount "
6332 "I</proc>, the normal root filesystem and any other filesystems it has "
6333 "mounted, and then terminates."
6337 #: build/C/man4/initrd.4:360
6338 msgid "The kernel then mounts the normal root filesystem."
6342 #: build/C/man4/initrd.4:363
6344 "Now that the filesystem is accessible and intact, the boot loader can be "
6349 #: build/C/man4/initrd.4:372
6351 "The boot loader is configured to load into I</dev/initrd> a filesystem with "
6352 "the set of modules that was used to bring up the system. (e.g., Device "
6353 "I</dev/ram0> can be modified, then unmounted, and finally, the image is "
6354 "written from I</dev/ram0> to a file.)"
6358 #: build/C/man4/initrd.4:372
6364 #: build/C/man4/initrd.4:375
6366 "The system is now bootable and additional installation tasks can be "
6371 #: build/C/man4/initrd.4:381
6373 "The key role of I</dev/initrd> in the above is to reuse the configuration "
6374 "data during normal system operation without requiring initial kernel "
6375 "selection, a large generic kernel or, recompiling the kernel."
6379 #: build/C/man4/initrd.4:394
6381 "A second scenario is for installations where Linux runs on systems with "
6382 "different hardware configurations in a single administrative network. In "
6383 "such cases, it may be desirable to use only a small set of kernels (ideally "
6384 "only one) and to keep the system-specific part of configuration information "
6385 "as small as possible. In this case, create a common file with all needed "
6386 "modules. Then, only the I</linuxrc> file or a file executed by I</linuxrc> "
6387 "would be different."
6391 #: build/C/man4/initrd.4:401
6393 "A third scenario is more convenient recovery disks. Because information "
6394 "like the location of the root filesystem partition is not needed at boot "
6395 "time, the system loaded from I</dev/initrd> can use a dialog and/or "
6396 "auto-detection followed by a possible sanity check."
6400 #: build/C/man4/initrd.4:418
6402 "Last but not least, Linux distributions on CD-ROM may use B<initrd> for easy "
6403 "installation from the CD-ROM. The distribution can use B<LOADLIN> to "
6404 "directly load I</dev/initrd> from CD-ROM without the need of any floppies. "
6405 "The distribution could also use a B<LILO> boot floppy and then bootstrap a "
6406 "bigger RAM disk via I</dev/initrd> from the CD-ROM."
6410 #: build/C/man4/initrd.4:420
6411 msgid "I</dev/initrd>"
6415 #: build/C/man4/initrd.4:422
6416 msgid "I</dev/ram0>"
6420 #: build/C/man4/initrd.4:424
6425 #: build/C/man4/initrd.4:429
6430 #: build/C/man4/initrd.4:441
6432 "With the current kernel, any filesystems that remain mounted when "
6433 "I</dev/ram0> is moved from I</> to I</initrd> continue to be accessible. "
6434 "However, the I</proc/mounts> entries are not updated."
6438 #: build/C/man4/initrd.4:458
6440 "With the current kernel, if directory I</initrd> does not exist, then "
6441 "I</dev/ram0> will B<not> be fully unmounted if I</dev/ram0> is used by any "
6442 "process or has any filesystem mounted on it. If I</dev/ram0> is B<not> "
6443 "fully unmounted, then I</dev/ram0> will remain in memory."
6450 #. The kernel code for device
6452 #. was written by Werner Almesberger <almesber@lrc.epfl.ch> and
6453 #. Hans Lermen <lermen@elserv.ffm.fgan.de>.
6456 #. was added to the baseline Linux kernel in development version 1.3.73.
6458 #: build/C/man4/initrd.4:474
6460 "Users of I</dev/initrd> should not depend on the behavior give in the above "
6461 "notes. The behavior may change in future versions of the Linux kernel."
6465 #: build/C/man4/initrd.4:480
6466 msgid "B<chown>(1), B<mknod>(1), B<ram>(4), B<freeramdisk>(8), B<rdev>(8)"
6470 #: build/C/man4/initrd.4:484
6472 "I<Documentation/initrd.txt> in the Linux kernel source tree, the LILO "
6473 "documentation, the LOADLIN documentation, the SYSLINUX documentation"
6477 #: build/C/man4/lp.4:27
6483 #: build/C/man4/lp.4:27
6489 #: build/C/man4/lp.4:30
6490 msgid "lp - line printer devices"
6494 #: build/C/man4/lp.4:32
6495 msgid "B<#include E<lt>linux/lp.hE<gt>>"
6499 #: build/C/man4/lp.4:43
6501 "B<lp>[0\\(en2] are character devices for the parallel line printers; they "
6502 "have major number 6 and minor number 0\\(en2. The minor numbers correspond "
6503 "to the printer port base addresses 0x03bc, 0x0378 and 0x0278. Usually they "
6504 "have mode 220 and are owned by root and group lp. You can use printer ports "
6505 "either with polling or with interrupts. Interrupts are recommended when "
6506 "high traffic is expected, for example, for laser printers. For usual dot "
6507 "matrix printers polling will usually be enough. The default is polling."
6511 #: build/C/man4/lp.4:47
6512 msgid "The following B<ioctl>(2) calls are supported:"
6516 #: build/C/man4/lp.4:47
6518 msgid "B<int ioctl(int >I<fd>B<, LPTIME, int >I<arg>B<)>"
6522 #: build/C/man4/lp.4:56
6524 "Sets the amount of time that the driver sleeps before rechecking the printer "
6525 "when the printer's buffer appears to be filled to I<arg>. If you have a "
6526 "fast printer, decrease this number; if you have a slow printer then increase "
6527 "it. This is in hundredths of a second, the default 2 being 0.02 seconds. "
6528 "It only influences the polling driver."
6532 #: build/C/man4/lp.4:56
6534 msgid "B<int ioctl(int >I<fd>B<, LPCHAR, int >I<arg>B<)>"
6538 #: build/C/man4/lp.4:64
6540 "Sets the maximum number of busy-wait iterations which the polling driver "
6541 "does while waiting for the printer to get ready for receiving a character to "
6542 "I<arg>. If printing is too slow, increase this number; if the system gets "
6543 "too slow, decrease this number. The default is 1000. It only influences "
6544 "the polling driver."
6548 #: build/C/man4/lp.4:64
6550 msgid "B<int ioctl(int >I<fd>B<, LPABORT, int >I<arg>B<)>"
6554 #: build/C/man4/lp.4:70
6556 "If I<arg> is 0, the printer driver will retry on errors, otherwise it will "
6557 "abort. The default is 0."
6561 #: build/C/man4/lp.4:70
6563 msgid "B<int ioctl(int >I<fd>B<, LPABORTOPEN, int >I<arg>B<)>"
6567 #: build/C/man4/lp.4:77
6569 "If I<arg> is 0, B<open>(2) will be aborted on error, otherwise error will "
6570 "be ignored. The default is to ignore it."
6574 #: build/C/man4/lp.4:77
6576 msgid "B<int ioctl(int >I<fd>B<, LPCAREFUL, int >I<arg>B<)>"
6580 #: build/C/man4/lp.4:83
6582 "If I<arg> is 0, then the out-of-paper, offline and error signals are "
6583 "required to be false on all writes, otherwise they are ignored. The default "
6584 "is to ignore them."
6588 #: build/C/man4/lp.4:83
6590 msgid "B<int ioctl(int >I<fd>B<, LPWAIT, int >I<arg>B<)>"
6594 #: build/C/man4/lp.4:94
6596 "Sets the number of busy waiting iterations to wait before strobing the "
6597 "printer to accept a just-written character, and the number of iterations to "
6598 "wait before turning the strobe off again, to I<arg>. The specification says "
6599 "this time should be 0.5 microseconds, but experience has shown the delay "
6600 "caused by the code is already enough. For that reason, the default value is "
6601 "0. This is used for both the polling and the interrupt driver."
6605 #: build/C/man4/lp.4:94
6607 msgid "B<int ioctl(int >I<fd>B<, LPSETIRQ, int >I<arg>B<)>"
6611 #: build/C/man4/lp.4:105
6613 "This B<ioctl>(2) requires superuser privileges. It takes an I<int> "
6614 "containing the new IRQ as argument. As a side effect, the printer will be "
6615 "reset. When I<arg> is 0, the polling driver will be used, which is also "
6620 #: build/C/man4/lp.4:105
6622 msgid "B<int ioctl(int >I<fd>B<, LPGETIRQ, int *>I<arg>B<)>"
6626 #: build/C/man4/lp.4:108
6627 msgid "Stores the currently used IRQ in I<arg>."
6631 #: build/C/man4/lp.4:108
6633 msgid "B<int ioctl(int >I<fd>B<, LPGETSTATUS, int *>I<arg>B<)>"
6637 #: build/C/man4/lp.4:112
6639 "Stores the value of the status port in I<arg>. The bits have the following "
6644 #: build/C/man4/lp.4:114
6646 msgid "LP_PBUSY\tinverted busy input, active high\n"
6650 #: build/C/man4/lp.4:115
6652 msgid "LP_PACK\tunchanged acknowledge input, active low\n"
6656 #: build/C/man4/lp.4:116
6658 msgid "LP_POUTPA\tunchanged out-of-paper input, active high\n"
6662 #: build/C/man4/lp.4:117
6664 msgid "LP_PSELECD\tunchanged selected input, active high\n"
6668 #: build/C/man4/lp.4:118
6670 msgid "LP_PERRORP\tunchanged error input, active low\n"
6674 #: build/C/man4/lp.4:123
6676 "Refer to your printer manual for the meaning of the signals. Note that "
6677 "undocumented bits may also be set, depending on your printer."
6681 #: build/C/man4/lp.4:123
6683 msgid "B<int ioctl(int >I<fd>B<, LPRESET)>"
6687 #: build/C/man4/lp.4:126
6688 msgid "Resets the printer. No argument is used."
6692 #. The printer driver was originally written by Jim Weigand and Linus
6694 #. It was further improved by Michael K.\& Johnson.
6695 #. The interrupt code was written by Nigel Gamble.
6696 #. Alan Cox modularized it.
6697 #. LPCAREFUL, LPABORT, LPGETSTATUS were added by Chris Metcalf.
6699 #: build/C/man4/lp.4:135
6704 #: build/C/man4/lp.4:141
6705 msgid "B<chmod>(1), B<chown>(1), B<mknod>(1), B<lpcntl>(8), B<tunelp>(8)"
6709 #: build/C/man3/makedev.3:26
6715 #: build/C/man3/makedev.3:26
6721 #: build/C/man3/makedev.3:29
6722 msgid "makedev, major, minor - manage a device number"
6726 #: build/C/man3/makedev.3:33
6729 "B<#define _BSD_SOURCE> /* See feature_test_macros(7) */\n"
6730 "B<#include E<lt>sys/types.hE<gt>>\n"
6734 #: build/C/man3/makedev.3:35
6736 msgid "B<dev_t makedev(int >I<maj>B<, int >I<min>B<);>\n"
6740 #: build/C/man3/makedev.3:38
6743 "B<unsigned int major(dev_t >I<dev>B<);>\n"
6744 "B<unsigned int minor(dev_t >I<dev>B<);>\n"
6748 #: build/C/man3/makedev.3:45
6750 "A device ID consists of two parts: a major ID, identifying the class of the "
6751 "device, and a minor ID, identifying a specific instance of a device in that "
6752 "class. A device ID is represented using the type I<dev_t>."
6756 #: build/C/man3/makedev.3:52
6758 "Given major and minor device IDs, B<makedev>() combines these to produce a "
6759 "device ID, returned as the function result. This device ID can be given to "
6760 "B<mknod>(2), for example."
6764 #: build/C/man3/makedev.3:62
6766 "The B<major>() and B<minor>() functions perform the converse task: given a "
6767 "device ID, they return, respectively, the major and minor components. These "
6768 "macros can be useful to, for example, decompose the device IDs in the "
6769 "structure returned by B<stat>(2)."
6772 #. The BSDs, HP-UX, Solaris, AIX, Irix
6774 #: build/C/man3/makedev.3:71
6776 "The B<makedev>(), B<major>(), and B<minor>() functions are not specified in "
6777 "POSIX.1, but are present on many other systems."
6781 #: build/C/man3/makedev.3:80
6783 "These interfaces are defined as macros. Since glibc 2.3.3, they have been "
6784 "aliases for three GNU-specific functions: B<gnu_dev_makedev>(), "
6785 "B<gnu_dev_major>(), and B<gnu_dev_minor>(). The latter names are exported, "
6786 "but the traditional names are more portable."
6790 #: build/C/man3/makedev.3:83
6791 msgid "B<mknod>(2), B<stat>(2)"
6795 #: build/C/man4/mem.4:26
6801 #: build/C/man4/mem.4:26 build/C/man4/ram.4:26
6807 #: build/C/man4/mem.4:29
6808 msgid "mem, kmem, port - system memory, kernel memory and system ports"
6812 #: build/C/man4/mem.4:34
6814 "B<mem> is a character device file that is an image of the main memory of the "
6815 "computer. It may be used, for example, to examine (and even patch) the "
6820 #: build/C/man4/mem.4:39
6822 "Byte addresses in B<mem> are interpreted as physical memory addresses. "
6823 "References to nonexistent locations cause errors to be returned."
6827 #: build/C/man4/mem.4:42
6829 "Examining and patching is likely to lead to unexpected results when "
6830 "read-only or write-only bits are present."
6834 #: build/C/man4/mem.4:44 build/C/man4/mem.4:59 build/C/man4/mem.4:72 build/C/man4/ram.4:35
6835 msgid "It is typically created by:"
6839 #: build/C/man4/mem.4:47
6840 msgid "mknod -m 660 /dev/mem c 1 1"
6844 #: build/C/man4/mem.4:49
6845 msgid "chown root:kmem /dev/mem"
6849 #: build/C/man4/mem.4:57
6851 "The file B<kmem> is the same as B<mem>, except that the kernel virtual "
6852 "memory rather than physical memory is accessed."
6856 #: build/C/man4/mem.4:62
6857 msgid "mknod -m 640 /dev/kmem c 1 2"
6861 #: build/C/man4/mem.4:64
6862 msgid "chown root:kmem /dev/kmem"
6866 #: build/C/man4/mem.4:70
6867 msgid "B<port> is similar to B<mem>, but the I/O ports are accessed."
6871 #: build/C/man4/mem.4:75
6872 msgid "mknod -m 660 /dev/port c 1 4"
6876 #: build/C/man4/mem.4:77
6877 msgid "chown root:mem /dev/port"
6881 #: build/C/man4/mem.4:80
6886 #: build/C/man4/mem.4:82
6887 msgid "I</dev/kmem>"
6891 #: build/C/man4/mem.4:84
6892 msgid "I</dev/port>"
6896 #: build/C/man4/mem.4:88
6897 msgid "B<chown>(1), B<mknod>(1), B<ioperm>(2)"
6901 #: build/C/man3/mkfifo.3:27
6907 #: build/C/man3/mkfifo.3:27 build/C/man2/mknod.2:14
6913 #: build/C/man3/mkfifo.3:27
6919 #: build/C/man3/mkfifo.3:30
6920 msgid "mkfifo - make a FIFO special file (a named pipe)"
6924 #: build/C/man3/mkfifo.3:34
6927 "B<#include E<lt>sys/types.hE<gt>>\n"
6928 "B<#include E<lt>sys/stat.hE<gt>>\n"
6932 #: build/C/man3/mkfifo.3:36
6934 msgid "B<int mkfifo(const char *>I<pathname>B<, mode_t >I<mode>B<);>\n"
6938 #: build/C/man3/mkfifo.3:44
6940 "B<mkfifo>() makes a FIFO special file with name I<pathname>. I<mode> "
6941 "specifies the FIFO's permissions. It is modified by the process's B<umask> "
6942 "in the usual way: the permissions of the created file are B<(>I<mode>B< & "
6947 #: build/C/man3/mkfifo.3:51
6949 "A FIFO special file is similar to a pipe, except that it is created in a "
6950 "different way. Instead of being an anonymous communications channel, a FIFO "
6951 "special file is entered into the filesystem by calling B<mkfifo>()."
6955 #: build/C/man3/mkfifo.3:61
6957 "Once you have created a FIFO special file in this way, any process can open "
6958 "it for reading or writing, in the same way as an ordinary file. However, it "
6959 "has to be open at both ends simultaneously before you can proceed to do any "
6960 "input or output operations on it. Opening a FIFO for reading normally "
6961 "blocks until some other process opens the same FIFO for writing, and vice "
6962 "versa. See B<fifo>(7) for nonblocking handling of FIFO special files."
6966 #: build/C/man3/mkfifo.3:67
6968 "On success B<mkfifo>() returns 0. In the case of an error, -1 is returned "
6969 "(in which case, I<errno> is set appropriately)."
6973 #: build/C/man3/mkfifo.3:68 build/C/man2/mknod.2:107 build/C/man4/st.4:829
6979 #: build/C/man3/mkfifo.3:72
6981 "One of the directories in I<pathname> did not allow search (execute) "
6986 #: build/C/man3/mkfifo.3:72 build/C/man2/mknod.2:115
6992 #: build/C/man3/mkfifo.3:76 build/C/man2/mknod.2:119
6994 "The user's quota of disk blocks or inodes on the filesystem has been "
6999 #: build/C/man3/mkfifo.3:76 build/C/man2/mknod.2:119
7005 #: build/C/man3/mkfifo.3:82 build/C/man2/mknod.2:126
7007 "I<pathname> already exists. This includes the case where I<pathname> is a "
7008 "symbolic link, dangling or not."
7012 #: build/C/man3/mkfifo.3:82 build/C/man2/mknod.2:138
7014 msgid "B<ENAMETOOLONG>"
7018 #: build/C/man3/mkfifo.3:90
7020 "Either the total length of I<pathname> is greater than B<PATH_MAX>, or an "
7021 "individual filename component has a length greater than B<NAME_MAX>. In the "
7022 "GNU system, there is no imposed limit on overall filename length, but some "
7023 "filesystems may place limits on the length of a component."
7027 #: build/C/man3/mkfifo.3:90 build/C/man2/mknod.2:141
7033 #: build/C/man3/mkfifo.3:94 build/C/man2/mknod.2:146
7035 "A directory component in I<pathname> does not exist or is a dangling "
7040 #: build/C/man3/mkfifo.3:94 build/C/man2/mknod.2:149 build/C/man4/st.4:857
7046 #: build/C/man3/mkfifo.3:97
7047 msgid "The directory or filesystem has no room for the new file."
7051 #: build/C/man3/mkfifo.3:97 build/C/man2/mknod.2:154
7057 #: build/C/man3/mkfifo.3:101 build/C/man2/mknod.2:159
7058 msgid "A component used as a directory in I<pathname> is not, in fact, a directory."
7062 #: build/C/man3/mkfifo.3:101 build/C/man2/mknod.2:173 build/C/man4/st.4:872
7068 #: build/C/man3/mkfifo.3:104
7069 msgid "I<pathname> refers to a read-only filesystem."
7073 #: build/C/man3/mkfifo.3:106
7074 msgid "POSIX.1-2001."
7078 #: build/C/man3/mkfifo.3:116
7080 "B<mkfifo>(1), B<close>(2), B<open>(2), B<read>(2), B<stat>(2), B<umask>(2), "
7081 "B<write>(2), B<mkfifoat>(3), B<fifo>(7)"
7085 #: build/C/man2/mknod.2:14
7091 #: build/C/man2/mknod.2:17
7092 msgid "mknod - create a special or ordinary file"
7096 #: build/C/man2/mknod.2:23
7099 "B<#include E<lt>sys/types.hE<gt>>\n"
7100 "B<#include E<lt>sys/stat.hE<gt>>\n"
7101 "B<#include E<lt>fcntl.hE<gt>>\n"
7102 "B<#include E<lt>unistd.hE<gt>>\n"
7106 #: build/C/man2/mknod.2:25
7109 "B<int mknod(const char *>I<pathname>B<, mode_t >I<mode>B<, dev_t "
7114 #: build/C/man2/mknod.2:30 build/C/man3/syslog.3:55
7115 msgid "Feature Test Macro Requirements for glibc (see B<feature_test_macros>(7)):"
7119 #: build/C/man2/mknod.2:33
7124 #: build/C/man2/mknod.2:37
7126 "_BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\\ E<gt>=\\ 500 || "
7127 "_XOPEN_SOURCE\\ &&\\ _XOPEN_SOURCE_EXTENDED"
7131 #: build/C/man2/mknod.2:49
7133 "The system call B<mknod>() creates a filesystem node (file, device special "
7134 "file or named pipe) named I<pathname>, with attributes specified by I<mode> "
7139 #: build/C/man2/mknod.2:56
7141 "The I<mode> argument specifies both the permissions to use and the type of "
7142 "node to be created. It should be a combination (using bitwise OR) of one of "
7143 "the file types listed below and the permissions for the new node."
7147 #: build/C/man2/mknod.2:61
7149 "The permissions are modified by the process's I<umask> in the usual way: the "
7150 "permissions of the created node are I<(mode & ~umask)>."
7153 #. (S_IFSOCK since Linux 1.2.4)
7155 #: build/C/man2/mknod.2:75
7157 "The file type must be one of B<S_IFREG>, B<S_IFCHR>, B<S_IFBLK>, B<S_IFIFO> "
7158 "or B<S_IFSOCK> to specify a regular file (which will be created empty), "
7159 "character special file, block special file, FIFO (named pipe), or UNIX "
7160 "domain socket, respectively. (Zero file type is equivalent to type "
7165 #: build/C/man2/mknod.2:88
7167 "If the file type is B<S_IFCHR> or B<S_IFBLK> then I<dev> specifies the major "
7168 "and minor numbers of the newly created device special file (B<makedev>(3) "
7169 "may be useful to build the value for I<dev>); otherwise it is ignored."
7173 #: build/C/man2/mknod.2:94
7175 "If I<pathname> already exists, or is a symbolic link, this call fails with "
7176 "an B<EEXIST> error."
7180 #: build/C/man2/mknod.2:101
7182 "The newly created node will be owned by the effective user ID of the "
7183 "process. If the directory containing the node has the set-group-ID bit set, "
7184 "or if the filesystem is mounted with BSD group semantics, the new node will "
7185 "inherit the group ownership from its parent directory; otherwise it will be "
7186 "owned by the effective group ID of the process."
7190 #: build/C/man2/mknod.2:106
7192 "B<mknod>() returns zero on success, or -1 if an error occurred (in which "
7193 "case, I<errno> is set appropriately)."
7197 #: build/C/man2/mknod.2:115
7199 "The parent directory does not allow write permission to the process, or one "
7200 "of the directories in the path prefix of I<pathname> did not allow search "
7201 "permission. (See also B<path_resolution>(7).)"
7205 #: build/C/man2/mknod.2:126 build/C/man4/st.4:838
7211 #: build/C/man2/mknod.2:129
7212 msgid "I<pathname> points outside your accessible address space."
7216 #: build/C/man2/mknod.2:134
7218 "I<mode> requested creation of something other than a regular file, device "
7219 "special file, FIFO or socket."
7223 #: build/C/man2/mknod.2:134
7229 #: build/C/man2/mknod.2:138
7230 msgid "Too many symbolic links were encountered in resolving I<pathname>."
7234 #: build/C/man2/mknod.2:141
7235 msgid "I<pathname> was too long."
7239 #: build/C/man2/mknod.2:146 build/C/man4/st.4:850
7245 #: build/C/man2/mknod.2:149
7246 msgid "Insufficient kernel memory was available."
7250 #: build/C/man2/mknod.2:154
7251 msgid "The device containing I<pathname> has no room for the new node."
7254 #. For UNIX domain sockets and regular files, EPERM is returned only in
7255 #. Linux 2.2 and earlier; in Linux 2.4 and later, unprivileged can
7256 #. use mknod() to make these files.
7258 #: build/C/man2/mknod.2:173
7260 "I<mode> requested creation of something other than a regular file, FIFO "
7261 "(named pipe), or UNIX domain socket, and the caller is not privileged "
7262 "(Linux: does not have the B<CAP_MKNOD> capability); also returned if the "
7263 "filesystem containing I<pathname> does not support the type of node "
7268 #: build/C/man2/mknod.2:177
7269 msgid "I<pathname> refers to a file on a read-only filesystem."
7272 #. The Linux version differs from the SVr4 version in that it
7273 #. does not require root permission to create pipes, also in that no
7274 #. EMULTIHOP, ENOLINK, or EINTR error is documented.
7276 #: build/C/man2/mknod.2:182
7277 msgid "SVr4, 4.4BSD, POSIX.1-2001 (but see below)."
7281 #: build/C/man2/mknod.2:200
7283 "POSIX.1-2001 says: \"The only portable use of B<mknod>() is to create a "
7284 "FIFO-special file. If I<mode> is not B<S_IFIFO> or I<dev> is not 0, the "
7285 "behavior of B<mknod>() is unspecified.\" However, nowadays one should never "
7286 "use B<mknod>() for this purpose; one should use B<mkfifo>(3), a function "
7287 "especially defined for this purpose."
7290 #. and one should make UNIX domain sockets with socket(2) and bind(2).
7292 #: build/C/man2/mknod.2:205
7294 "Under Linux, this call cannot be used to create directories. One should "
7295 "make directories with B<mkdir>(2)."
7299 #: build/C/man2/mknod.2:209
7301 "There are many infelicities in the protocol underlying NFS. Some of these "
7302 "affect B<mknod>()."
7306 #: build/C/man2/mknod.2:223
7308 "B<chmod>(2), B<chown>(2), B<fcntl>(2), B<mkdir>(2), B<mknodat>(2), "
7309 "B<mount>(2), B<socket>(2), B<stat>(2), B<umask>(2), B<unlink>(2), "
7310 "B<makedev>(3), B<mkfifo>(3), B<path_resolution>(7)"
7314 #: build/C/man4/mouse.4:26
7320 #: build/C/man4/mouse.4:26
7326 #: build/C/man4/mouse.4:29
7327 msgid "mouse - serial mouse interface"
7331 #: build/C/man4/mouse.4:33
7333 "Serial mice are connected to a serial RS232/V24 dialout line, see B<ttyS>(4) "
7334 "for a description."
7338 #: build/C/man4/mouse.4:34
7340 msgid "Introduction"
7344 #: build/C/man4/mouse.4:36
7345 msgid "The pinout of the usual 9 pin plug as used for serial mice is:"
7349 #: build/C/man4/mouse.4:39
7351 msgid "pin\tname\tused for\n"
7355 #: build/C/man4/mouse.4:40
7357 msgid "2\tRX\tData\n"
7361 #: build/C/man4/mouse.4:41
7363 msgid "3\tTX\t-12 V, Imax = 10 mA\n"
7367 #: build/C/man4/mouse.4:42
7369 msgid "4\tDTR\t+12 V, Imax = 10 mA\n"
7373 #: build/C/man4/mouse.4:43
7375 msgid "7\tRTS\t+12 V, Imax = 10 mA\n"
7379 #: build/C/man4/mouse.4:44
7381 msgid "5\tGND\tGround\n"
7385 #: build/C/man4/mouse.4:48
7386 msgid "This is the specification, in fact 9 V suffices with most mice."
7390 #: build/C/man4/mouse.4:54
7392 "The mouse driver can recognize a mouse by dropping RTS to low and raising it "
7393 "again. About 14 ms later the mouse will send 0x4D (\\(aqM\\(aq) on the data "
7394 "line. After a further 63 ms, a Microsoft-compatible 3-button mouse will "
7395 "send 0x33 (\\(aq3\\(aq)."
7399 #: build/C/man4/mouse.4:66
7401 "The relative mouse movement is sent as I<dx> (positive means right) and "
7402 "I<dy> (positive means down). Various mice can operate at different speeds. "
7403 "To select speeds, cycle through the speeds 9600, 4800, 2400 and 1200 bit/s, "
7404 "each time writing the two characters from the table below and waiting 0.1 "
7405 "seconds. The following table shows available speeds and the strings that "
7410 #: build/C/man4/mouse.4:69
7412 msgid "bit/s\tstring\n"
7416 #: build/C/man4/mouse.4:70
7422 #: build/C/man4/mouse.4:71
7428 #: build/C/man4/mouse.4:72
7434 #: build/C/man4/mouse.4:73
7440 #: build/C/man4/mouse.4:77
7441 msgid "The first byte of a data packet can be used to synchronization purposes."
7445 #: build/C/man4/mouse.4:77
7447 msgid "Microsoft protocol"
7451 #: build/C/man4/mouse.4:93
7453 "The B<Microsoft> protocol uses 1 start bit, 7 data bits, no parity and one "
7454 "stop bit at the speed of 1200 bits/sec. Data is sent to RxD in 3-byte "
7455 "packets. The I<dx> and I<dy> movements are sent as two's-complement, I<lb> "
7456 "(I<rb>) are set when the left (right) button is pressed:"
7460 #: build/C/man4/mouse.4:96
7462 msgid "byte\td6\td5\td4\td3\td2\td1\td0\n"
7466 #: build/C/man4/mouse.4:97
7468 msgid "1\t1\tlb\trb\tdy7\tdy6\tdx7\tdx6\n"
7472 #: build/C/man4/mouse.4:98
7474 msgid "2\t0\tdx5\tdx4\tdx3\tdx2\tdx1\tdx0\n"
7478 #: build/C/man4/mouse.4:99
7480 msgid "3\t0\tdy5\tdy4\tdy3\tdy2\tdy1\tdy0\n"
7484 #: build/C/man4/mouse.4:101
7486 msgid "3-button Microsoft protocol"
7490 #: build/C/man4/mouse.4:110
7492 "Original Microsoft mice only have two buttons. However, there are some "
7493 "three button mice which also use the Microsoft protocol. Pressing or "
7494 "releasing the middle button is reported by sending a packet with zero "
7495 "movement and no buttons pressed. (Thus, unlike for the other two buttons, "
7496 "the status of the middle button is not reported in each packet.)"
7500 #: build/C/man4/mouse.4:110
7502 msgid "Logitech protocol"
7506 #: build/C/man4/mouse.4:119
7508 "Logitech serial 3-button mice use a different extension of the Microsoft "
7509 "protocol: when the middle button is up, the above 3-byte packet is sent. "
7510 "When the middle button is down a 4-byte packet is sent, where the 4th byte "
7511 "has value 0x20 (or at least has the 0x20 bit set). In particular, a press "
7512 "of the middle button is reported as 0,0,0,0x20 when no other buttons are "
7517 #: build/C/man4/mouse.4:119
7519 msgid "Mousesystems protocol"
7523 #: build/C/man4/mouse.4:137
7525 "The B<Mousesystems> protocol uses 1 start bit, 8 data bits, no parity and "
7526 "two stop bits at the speed of 1200 bits/sec. Data is sent to RxD in 5-byte "
7527 "packets. I<dx> is sent as the sum of the two two's-complement values, I<dy> "
7528 "is send as negated sum of the two two's-complement values. I<lb> (I<mb>, "
7529 "I<rb>) are cleared when the left (middle, right) button is pressed:"
7533 #: build/C/man4/mouse.4:140 build/C/man4/mouse.4:175
7535 msgid "byte\td7\td6\td5\td4\td3\td2\td1\td0\n"
7539 #: build/C/man4/mouse.4:141
7541 msgid "1\t1\t0\t0\t0\t0\tlb\tmb\trb\n"
7545 #: build/C/man4/mouse.4:142
7547 msgid "2\t0\tdxa6\tdxa5\tdxa4\tdxa3\tdxa2\tdxa1\tdxa0\n"
7551 #: build/C/man4/mouse.4:143
7553 msgid "3\t0\tdya6\tdya5\tdya4\tdya3\tdya2\tdya1\tdya0\n"
7557 #: build/C/man4/mouse.4:144
7559 msgid "4\t0\tdxb6\tdxb5\tdxb4\tdxb3\tdxb2\tdxb1\tdxb0\n"
7563 #: build/C/man4/mouse.4:145
7565 msgid "5\t0\tdyb6\tdyb5\tdyb4\tdyb3\tdyb2\tdyb1\tdyb0\n"
7569 #: build/C/man4/mouse.4:150
7571 "Bytes 4 and 5 describe the change that occurred since bytes 2 and 3 were "
7576 #: build/C/man4/mouse.4:150
7578 msgid "Sun protocol"
7582 #: build/C/man4/mouse.4:155
7584 "The B<Sun> protocol is the 3-byte version of the above 5-byte Mousesystems "
7585 "protocol: the last two bytes are not sent."
7589 #: build/C/man4/mouse.4:155
7595 #: build/C/man4/mouse.4:172
7597 "The B<MM> protocol uses 1 start bit, 8 data bits, odd parity and one stop "
7598 "bit at the speed of 1200 bits/sec. Data is sent to RxD in 3-byte packets. "
7599 "I<dx> and I<dy> are sent as single signed values, the sign bit indicating a "
7600 "negative value. I<lb> (I<mb>, I<rb>) are set when the left (middle, right) "
7601 "button is pressed:"
7605 #: build/C/man4/mouse.4:176
7607 msgid "1\t1\t0\t0\tdxs\tdys\tlb\tmb\trb\n"
7611 #: build/C/man4/mouse.4:177
7613 msgid "2\t0\tdx6\tdx5\tdx4\tdx3\tdx2\tdx1\tdx0\n"
7617 #: build/C/man4/mouse.4:178
7619 msgid "3\t0\tdy6\tdy5\tdy4\tdy3\tdy2\tdy1\tdy0\n"
7623 #: build/C/man4/mouse.4:181
7625 msgid "I</dev/mouse>"
7629 #: build/C/man4/mouse.4:184
7630 msgid "A commonly used symlink pointing to a mouse device."
7634 #: build/C/man4/mouse.4:187
7635 msgid "B<ttyS>(4), B<gpm>(8)"
7639 #: build/C/man4/msr.4:26
7645 #: build/C/man4/msr.4:29
7646 msgid "msr - x86 CPU MSR access device"
7650 #: build/C/man4/msr.4:36
7652 "I</dev/cpu/CPUNUM/msr> provides an interface to read and write the "
7653 "model-specific registers (MSRs) of an x86 CPU. I<CPUNUM> is the number of "
7654 "the CPU to access as listed in I</proc/cpuinfo>."
7658 #: build/C/man4/msr.4:42
7660 "The register access is done by opening the file and seeking to the MSR "
7661 "number as offset in the file, and then reading or writing in chunks of 8 "
7662 "bytes. An I/O transfer of more than 8 bytes means multiple reads or writes "
7663 "of the same register."
7667 #: build/C/man4/msr.4:47
7669 "This file is protected so that it can be read and written only by the user "
7670 "I<root>, or members of the group I<root>."
7674 #: build/C/man4/msr.4:53
7676 "The I<msr> driver is not auto-loaded. On modular kernels you might need to "
7677 "use the following command to load it explicitly before use:"
7681 #: build/C/man4/msr.4:55
7683 msgid " $ I<modprobe msr>\n"
7687 #: build/C/man4/msr.4:59
7689 "Intel Corporation Intel 64 and IA-32 Architectures Software Developer's "
7690 "Manual Volume 3B Appendix B, for an overview of the Intel CPU MSRs."
7694 #: build/C/man4/null.4:26
7700 #: build/C/man4/null.4:26
7706 #: build/C/man4/null.4:29
7707 msgid "null, zero - data sink"
7711 #: build/C/man4/null.4:35
7712 msgid "Data written to a B<null> or B<zero> special file is discarded."
7716 #: build/C/man4/null.4:44
7718 "Reads from the B<null> special file always return end of file (i.e., "
7719 "B<read>(2) returns 0), whereas reads from B<zero> always return bytes "
7720 "containing zero (\\e0 characters)."
7724 #: build/C/man4/null.4:49
7725 msgid "B<null> and B<zero> are typically created by:"
7729 #: build/C/man4/null.4:52
7730 msgid "mknod -m 666 /dev/null c 1 3"
7734 #: build/C/man4/null.4:54
7735 msgid "mknod -m 666 /dev/zero c 1 5"
7739 #: build/C/man4/null.4:56
7740 msgid "chown root:root /dev/null /dev/zero"
7744 #: build/C/man4/null.4:59
7745 msgid "I</dev/null>"
7749 #: build/C/man4/null.4:61
7750 msgid "I</dev/zero>"
7754 #: build/C/man4/null.4:64
7756 "If these devices are not writable and readable for all users, many programs "
7757 "will act strangely."
7761 #: build/C/man4/null.4:68
7762 msgid "B<chown>(1), B<mknod>(1), B<full>(4)"
7766 #: build/C/man7/pipe.7:25
7772 #: build/C/man7/pipe.7:25
7778 #: build/C/man7/pipe.7:28
7779 msgid "pipe - overview of pipes and FIFOs"
7783 #: build/C/man7/pipe.7:37
7785 "Pipes and FIFOs (also known as named pipes) provide a unidirectional "
7786 "interprocess communication channel. A pipe has a I<read end> and a I<write "
7787 "end>. Data written to the write end of a pipe can be read from the read end "
7792 #: build/C/man7/pipe.7:47
7794 "A pipe is created using B<pipe>(2), which creates a new pipe and returns two "
7795 "file descriptors, one referring to the read end of the pipe, the other "
7796 "referring to the write end. Pipes can be used to create a communication "
7797 "channel between related processes; see B<pipe>(2) for an example."
7801 #: build/C/man7/pipe.7:66
7803 "A FIFO (short for First In First Out) has a name within the filesystem "
7804 "(created using B<mkfifo>(3)), and is opened using B<open>(2). Any process "
7805 "may open a FIFO, assuming the file permissions allow it. The read end is "
7806 "opened using the B<O_RDONLY> flag; the write end is opened using the "
7807 "B<O_WRONLY> flag. See B<fifo>(7) for further details. I<Note>: although "
7808 "FIFOs have a pathname in the filesystem, I/O on FIFOs does not involve "
7809 "operations on the underlying device (if there is one)."
7813 #: build/C/man7/pipe.7:66
7815 msgid "I/O on pipes and FIFOs"
7819 #: build/C/man7/pipe.7:71
7821 "The only difference between pipes and FIFOs is the manner in which they are "
7822 "created and opened. Once these tasks have been accomplished, I/O on pipes "
7823 "and FIFOs has exactly the same semantics."
7827 #: build/C/man7/pipe.7:85
7829 "If a process attempts to read from an empty pipe, then B<read>(2) will "
7830 "block until data is available. If a process attempts to write to a full "
7831 "pipe (see below), then B<write>(2) blocks until sufficient data has been "
7832 "read from the pipe to allow the write to complete. Nonblocking I/O is "
7833 "possible by using the B<fcntl>(2) B<F_SETFL> operation to enable the "
7834 "B<O_NONBLOCK> open file status flag."
7838 #: build/C/man7/pipe.7:89
7840 "The communication channel provided by a pipe is a I<byte stream>: there is "
7841 "no concept of message boundaries."
7845 #: build/C/man7/pipe.7:116
7847 "If all file descriptors referring to the write end of a pipe have been "
7848 "closed, then an attempt to B<read>(2) from the pipe will see end-of-file "
7849 "(B<read>(2) will return 0). If all file descriptors referring to the read "
7850 "end of a pipe have been closed, then a B<write>(2) will cause a B<SIGPIPE> "
7851 "signal to be generated for the calling process. If the calling process is "
7852 "ignoring this signal, then B<write>(2) fails with the error B<EPIPE>. An "
7853 "application that uses B<pipe>(2) and B<fork>(2) should use suitable "
7854 "B<close>(2) calls to close unnecessary duplicate file descriptors; this "
7855 "ensures that end-of-file and B<SIGPIPE>/B<EPIPE> are delivered when "
7860 #: build/C/man7/pipe.7:120
7861 msgid "It is not possible to apply B<lseek>(2) to a pipe."
7865 #: build/C/man7/pipe.7:120
7867 msgid "Pipe capacity"
7871 #: build/C/man7/pipe.7:132
7873 "A pipe has a limited capacity. If the pipe is full, then a B<write>(2) "
7874 "will block or fail, depending on whether the B<O_NONBLOCK> flag is set (see "
7875 "below). Different implementations have different limits for the pipe "
7876 "capacity. Applications should not rely on a particular capacity: an "
7877 "application should be designed so that a reading process consumes data as "
7878 "soon as it is available, so that a writing process does not remain blocked."
7882 #: build/C/man7/pipe.7:136
7884 "In Linux versions before 2.6.11, the capacity of a pipe was the same as the "
7885 "system page size (e.g., 4096 bytes on i386). Since Linux 2.6.11, the pipe "
7886 "capacity is 65536 bytes."
7890 #: build/C/man7/pipe.7:136
7896 #: build/C/man7/pipe.7:158
7898 "POSIX.1-2001 says that B<write>(2)s of less than B<PIPE_BUF> bytes must be "
7899 "atomic: the output data is written to the pipe as a contiguous sequence. "
7900 "Writes of more than B<PIPE_BUF> bytes may be nonatomic: the kernel may "
7901 "interleave the data with data written by other processes. POSIX.1-2001 "
7902 "requires B<PIPE_BUF> to be at least 512 bytes. (On Linux, B<PIPE_BUF> is "
7903 "4096 bytes.) The precise semantics depend on whether the file descriptor is "
7904 "nonblocking (B<O_NONBLOCK>), whether there are multiple writers to the pipe, "
7905 "and on I<n>, the number of bytes to be written:"
7909 #: build/C/man7/pipe.7:158
7911 msgid "B<O_NONBLOCK> disabled, I<n> E<lt>= B<PIPE_BUF>"
7915 #: build/C/man7/pipe.7:167
7917 "All I<n> bytes are written atomically; B<write>(2) may block if there is "
7918 "not room for I<n> bytes to be written immediately"
7922 #: build/C/man7/pipe.7:167
7924 msgid "B<O_NONBLOCK> enabled, I<n> E<lt>= B<PIPE_BUF>"
7928 #: build/C/man7/pipe.7:181
7930 "If there is room to write I<n> bytes to the pipe, then B<write>(2) succeeds "
7931 "immediately, writing all I<n> bytes; otherwise B<write>(2) fails, with "
7932 "I<errno> set to B<EAGAIN>."
7936 #: build/C/man7/pipe.7:181
7938 msgid "B<O_NONBLOCK> disabled, I<n> E<gt> B<PIPE_BUF>"
7942 #: build/C/man7/pipe.7:193
7944 "The write is nonatomic: the data given to B<write>(2) may be interleaved "
7945 "with B<write>(2)s by other process; the B<write>(2) blocks until I<n> bytes "
7946 "have been written."
7950 #: build/C/man7/pipe.7:193
7952 msgid "B<O_NONBLOCK> enabled, I<n> E<gt> B<PIPE_BUF>"
7956 #: build/C/man7/pipe.7:208
7958 "If the pipe is full, then B<write>(2) fails, with I<errno> set to "
7959 "B<EAGAIN>. Otherwise, from 1 to I<n> bytes may be written (i.e., a "
7960 "\"partial write\" may occur; the caller should check the return value from "
7961 "B<write>(2) to see how many bytes were actually written), and these bytes "
7962 "may be interleaved with writes by other processes."
7966 #: build/C/man7/pipe.7:208
7968 msgid "Open file status flags"
7972 #: build/C/man7/pipe.7:214
7974 "The only open file status flags that can be meaningfully applied to a pipe "
7975 "or FIFO are B<O_NONBLOCK> and B<O_ASYNC>."
7979 #: build/C/man7/pipe.7:226
7981 "Setting the B<O_ASYNC> flag for the read end of a pipe causes a signal "
7982 "(B<SIGIO> by default) to be generated when new input becomes available on "
7983 "the pipe (see B<fcntl>(2) for details). On Linux, B<O_ASYNC> is supported "
7984 "for pipes and FIFOs only since kernel 2.6."
7988 #: build/C/man7/pipe.7:226
7990 msgid "Portability notes"
7994 #: build/C/man7/pipe.7:232
7996 "On some systems (but not Linux), pipes are bidirectional: data can be "
7997 "transmitted in both directions between the pipe ends. According to "
7998 "POSIX.1-2001, pipes only need to be unidirectional. Portable applications "
7999 "should avoid reliance on bidirectional pipe semantics."
8003 #: build/C/man7/pipe.7:244
8005 "B<dup>(2), B<fcntl>(2), B<open>(2), B<pipe>(2), B<poll>(2), B<select>(2), "
8006 "B<socketpair>(2), B<stat>(2), B<mkfifo>(3), B<epoll>(7), B<fifo>(7)"
8010 #: build/C/man4/ram.4:26
8016 #: build/C/man4/ram.4:29
8017 msgid "ram - ram disk device"
8021 #: build/C/man4/ram.4:33
8022 msgid "The I<ram> device is a block device to access the ram disk in raw mode."
8026 #: build/C/man4/ram.4:38
8027 msgid "mknod -m 660 /dev/ram b 1 1"
8031 #: build/C/man4/ram.4:40
8032 msgid "chown root:disk /dev/ram"
8036 #: build/C/man4/ram.4:43
8041 #: build/C/man4/ram.4:47
8042 msgid "B<chown>(1), B<mknod>(1), B<mount>(8)"
8046 #: build/C/man4/random.4:19
8052 #: build/C/man4/random.4:19 build/C/man3/stdarg.3:43
8058 #: build/C/man4/random.4:22
8059 msgid "random, urandom - kernel random number source devices"
8063 #: build/C/man4/random.4:24
8064 msgid "#include E<lt>linux/random.hE<gt>"
8068 #: build/C/man4/random.4:26
8069 msgid "B<int ioctl(>I<fd>B<, RND>I<request>B<, >I<param>B<);>"
8073 #: build/C/man4/random.4:33
8075 "The character special files I</dev/random> and I</dev/urandom> (present "
8076 "since Linux 1.3.30) provide an interface to the kernel's random number "
8077 "generator. File I</dev/random> has major device number 1 and minor device "
8078 "number 8. File I</dev/urandom> has major device number 1 and minor device "
8083 #: build/C/man4/random.4:39
8085 "The random number generator gathers environmental noise from device drivers "
8086 "and other sources into an entropy pool. The generator also keeps an "
8087 "estimate of the number of bits of noise in the entropy pool. From this "
8088 "entropy pool random numbers are created."
8092 #: build/C/man4/random.4:47
8094 "When read, the I</dev/random> device will only return random bytes within "
8095 "the estimated number of bits of noise in the entropy pool. I</dev/random> "
8096 "should be suitable for uses that need very high quality randomness such as "
8097 "one-time pad or key generation. When the entropy pool is empty, reads from "
8098 "I</dev/random> will block until additional environmental noise is gathered."
8102 #: build/C/man4/random.4:58
8104 "A read from the I</dev/urandom> device will not block waiting for more "
8105 "entropy. As a result, if there is not sufficient entropy in the entropy "
8106 "pool, the returned values are theoretically vulnerable to a cryptographic "
8107 "attack on the algorithms used by the driver. Knowledge of how to do this is "
8108 "not available in the current unclassified literature, but it is "
8109 "theoretically possible that such an attack may exist. If this is a concern "
8110 "in your application, use I</dev/random> instead."
8114 #: build/C/man4/random.4:65
8116 "Writing to I</dev/random> or I</dev/urandom> will update the entropy pool "
8117 "with the data written, but this will not result in a higher entropy count. "
8118 "This means that it will impact the contents read from both files, but it "
8119 "will not make reads from I</dev/random> faster."
8123 #: build/C/man4/random.4:74
8125 "If you are unsure about whether you should use I</dev/random> or "
8126 "I</dev/urandom>, then probably you want to use the latter. As a general "
8127 "rule, I</dev/urandom> should be used for everything except long-lived "
8132 #: build/C/man4/random.4:86
8134 "If a seed file is saved across reboots as recommended below (all major Linux "
8135 "distributions have done this since 2000 at least), the output is "
8136 "cryptographically secure against attackers without local root access as soon "
8137 "as it is reloaded in the boot sequence, and perfectly adequate for network "
8138 "encryption session keys. Since reads from I</dev/random> may block, users "
8139 "will usually want to open it in nonblocking mode (or perform a read with "
8140 "timeout), and provide some sort of user notification if the desired entropy "
8141 "is not immediately available."
8145 #: build/C/man4/random.4:99
8147 "The kernel random-number generator is designed to produce a small amount of "
8148 "high-quality seed material to seed a cryptographic pseudo-random number "
8149 "generator (CPRNG). It is designed for security, not speed, and is poorly "
8150 "suited to generating large amounts of random data. Users should be very "
8151 "economical in the amount of seed material that they read from "
8152 "I</dev/urandom> (and I</dev/random>); unnecessarily reading large quantities "
8153 "of data from this device will have a negative impact on other users of the "
8158 #: build/C/man4/random.4:107
8160 "The amount of seed material required to generate a cryptographic key equals "
8161 "the effective key size of the key. For example, a 3072-bit RSA or "
8162 "Diffie-Hellman private key has an effective key size of 128 bits (it "
8163 "requires about 2^128 operations to break) so a key generator only needs 128 "
8164 "bits (16 bytes) of seed material from I</dev/random>."
8168 #: build/C/man4/random.4:116
8170 "While some safety margin above that minimum is reasonable, as a guard "
8171 "against flaws in the CPRNG algorithm, no cryptographic primitive available "
8172 "today can hope to promise more than 256 bits of security, so if any program "
8173 "reads more than 256 bits (32 bytes) from the kernel random pool per "
8174 "invocation, or per reasonable reseed interval (not less than one minute), "
8175 "that should be taken as a sign that its cryptography is I<not> skillfully "
8180 #: build/C/man4/random.4:116
8182 msgid "Configuration"
8186 #: build/C/man4/random.4:120
8188 "If your system does not have I</dev/random> and I</dev/urandom> created "
8189 "already, they can be created with the following commands:"
8193 #: build/C/man4/random.4:125
8196 " mknod -m 644 /dev/random c 1 8\n"
8197 " mknod -m 644 /dev/urandom c 1 9\n"
8198 " chown root:root /dev/random /dev/urandom\n"
8202 #: build/C/man4/random.4:135
8204 "When a Linux system starts up without much operator interaction, the entropy "
8205 "pool may be in a fairly predictable state. This reduces the actual amount "
8206 "of noise in the entropy pool below the estimate. In order to counteract "
8207 "this effect, it helps to carry entropy pool information across shut-downs "
8208 "and start-ups. To do this, add the following lines to an appropriate script "
8209 "which is run during the Linux system start-up sequence:"
8213 #: build/C/man4/random.4:150
8216 " echo \"Initializing random number generator...\"\n"
8217 " random_seed=/var/run/random-seed\n"
8218 " # Carry a random seed from start-up to start-up\n"
8219 " # Load and then save the whole entropy pool\n"
8220 " if [ -f $random_seed ]; then\n"
8221 " cat $random_seed E<gt>/dev/urandom\n"
8223 " touch $random_seed\n"
8225 " chmod 600 $random_seed\n"
8226 " poolfile=/proc/sys/kernel/random/poolsize\n"
8227 " [ -r $poolfile ] && bytes=\\`cat $poolfile\\` || bytes=512\n"
8228 " dd if=/dev/urandom of=$random_seed count=1 bs=$bytes\n"
8232 #: build/C/man4/random.4:154
8234 "Also, add the following lines in an appropriate script which is run during "
8235 "the Linux system shutdown:"
8239 #: build/C/man4/random.4:165
8242 " # Carry a random seed from shut-down to start-up\n"
8243 " # Save the whole entropy pool\n"
8244 " echo \"Saving random seed...\"\n"
8245 " random_seed=/var/run/random-seed\n"
8246 " touch $random_seed\n"
8247 " chmod 600 $random_seed\n"
8248 " poolfile=/proc/sys/kernel/random/poolsize\n"
8249 " [ -r $poolfile ] && bytes=\\`cat $poolfile\\` || bytes=512\n"
8250 " dd if=/dev/urandom of=$random_seed count=1 bs=$bytes\n"
8254 #: build/C/man4/random.4:166
8256 msgid "/proc Interface"
8260 #: build/C/man4/random.4:172
8262 "The files in the directory I</proc/sys/kernel/random> (present since 2.3.16) "
8263 "provide an additional interface to the I</dev/random> device."
8267 #: build/C/man4/random.4:178
8269 "The read-only file I<entropy_avail> gives the available entropy. Normally, "
8270 "this will be 4096 (bits), a full entropy pool."
8274 #: build/C/man4/random.4:183
8276 "The file I<poolsize> gives the size of the entropy pool. The semantics of "
8277 "this file vary across kernel versions:"
8281 #: build/C/man4/random.4:184
8287 #: build/C/man4/random.4:191
8289 "This file gives the size of the entropy pool in I<bytes>. Normally, this "
8290 "file will have the value 512, but it is writable, and can be changed to any "
8291 "value for which an algorithm is available. The choices are 32, 64, 128, "
8292 "256, 512, 1024, or 2048."
8296 #: build/C/man4/random.4:191
8302 #: build/C/man4/random.4:196
8304 "This file is read-only, and gives the size of the entropy pool in I<bits>. "
8305 "It contains the value 4096."
8309 #: build/C/man4/random.4:214
8311 "The file I<read_wakeup_threshold> contains the number of bits of entropy "
8312 "required for waking up processes that sleep waiting for entropy from "
8313 "I</dev/random>. The default is 64. The file I<write_wakeup_threshold> "
8314 "contains the number of bits of entropy below which we wake up processes that "
8315 "do a B<select>(2) or B<poll>(2) for write access to I</dev/random>. These "
8316 "values can be changed by writing to the files."
8320 #: build/C/man4/random.4:222
8322 "The read-only files I<uuid> and I<boot_id> contain random strings like "
8323 "6fd5a44b-35f4-4ad4-a9b9-6b9be13e1fe9. The former is generated afresh for "
8324 "each read, the latter was generated once."
8328 #: build/C/man4/random.4:222
8330 msgid "ioctl(2) interface"
8334 #: build/C/man4/random.4:233
8336 "The following B<ioctl>(2) requests are defined on file descriptors "
8337 "connected to either I</dev/random> or I</dev/urandom>. All requests "
8338 "performed will interact with the input entropy pool impacting both "
8339 "I</dev/random> and I</dev/urandom>. The B<CAP_SYS_ADMIN> capability is "
8340 "required for all requests except B<RNDGETENTCNT>."
8344 #: build/C/man4/random.4:233
8346 msgid "B<RNDGETENTCNT>"
8350 #: build/C/man4/random.4:240
8352 "Retrieve the entropy count of the input pool, the contents will be the same "
8353 "as the I<entropy_avail> file under proc. The result will be stored in the "
8354 "int pointed to by the argument."
8358 #: build/C/man4/random.4:240
8360 msgid "B<RNDADDTOENTCNT>"
8364 #: build/C/man4/random.4:244
8366 "Increment or decrement the entropy count of the input pool by the value "
8367 "pointed to by the argument."
8371 #: build/C/man4/random.4:244
8373 msgid "B<RNDGETPOOL>"
8377 #: build/C/man4/random.4:247
8378 msgid "Removed in Linux 2.6.9."
8382 #: build/C/man4/random.4:247
8384 msgid "B<RNDADDENTROPY>"
8388 #: build/C/man4/random.4:255
8390 "Add some additional entropy to the input pool, incrementing the entropy "
8391 "count. This differs from writing to I</dev/random> or I</dev/urandom>, "
8392 "which only adds some data but does not increment the entropy count. The "
8393 "following structure is used:"
8397 #: build/C/man4/random.4:262
8400 " struct rand_pool_info {\n"
8401 " int entropy_count;\n"
8408 #: build/C/man4/random.4:271
8410 "Here I<entropy_count> is the value added to (or subtracted from) the entropy "
8411 "count, and I<buf> is the buffer of size I<buf_size> which gets added to the "
8416 #: build/C/man4/random.4:271
8418 msgid "B<RNDZAPENTCNT>, B<RNDCLEARPOOL>"
8422 #: build/C/man4/random.4:275
8424 "Zero the entropy count of all pools and add some system data (such as wall "
8425 "clock) to the pools."
8429 #: build/C/man4/random.4:277
8434 #. The kernel's random number generator was written by
8435 #. Theodore Ts'o (tytso@athena.mit.edu).
8437 #: build/C/man4/random.4:282
8438 msgid "/dev/urandom"
8442 #: build/C/man4/random.4:284
8447 #: build/C/man4/random.4:286
8448 msgid "RFC\\ 1750, \"Randomness Recommendations for Security\""
8452 #: build/C/man4/sd.4:26
8458 #: build/C/man4/sd.4:26
8464 #: build/C/man4/sd.4:29
8465 msgid "sd - driver for SCSI disk drives"
8469 #: build/C/man4/sd.4:33
8472 "B<#include E<lt>linux/hdreg.hE<gt> >/* for HDIO_GETGEO */\n"
8473 "B<#include E<lt>linux/fs.hE<gt> >/* for BLKGETSIZE and BLKRRPART "
8478 #: build/C/man4/sd.4:45
8480 "The block device name has the following form: B<sd>I<lp,> where I<l> is a "
8481 "letter denoting the physical drive, and I<p> is a number denoting the "
8482 "partition on that physical drive. Often, the partition number, I<p>, will "
8483 "be left off when the device corresponds to the whole drive."
8487 #: build/C/man4/sd.4:54
8489 "SCSI disks have a major device number of 8, and a minor device number of the "
8490 "form (16 * I<drive_number>) + I<partition_number>, where I<drive_number> is "
8491 "the number of the physical drive in order of detection, and "
8492 "I<partition_number> is as follows:"
8496 #: build/C/man4/sd.4:56
8497 msgid "partition 0 is the whole drive"
8501 #: build/C/man4/sd.4:58
8502 msgid "partitions 1-4 are the DOS \"primary\" partitions"
8506 #: build/C/man4/sd.4:60
8507 msgid "partitions 5-8 are the DOS \"extended\" (or \"logical\") partitions"
8511 #: build/C/man4/sd.4:68
8513 "For example, I</dev/sda> will have major 8, minor 0, and will refer to all "
8514 "of the first SCSI drive in the system; and I</dev/sdb3> will have major 8, "
8515 "minor 19, and will refer to the third DOS \"primary\" partition on the "
8516 "second SCSI drive in the system."
8520 #: build/C/man4/sd.4:71
8522 "At this time, only block devices are provided. Raw devices have not yet "
8527 #: build/C/man4/sd.4:75
8528 msgid "The following I<ioctl>s are provided:"
8532 #: build/C/man4/sd.4:75
8534 msgid "B<HDIO_GETGEO>"
8538 #: build/C/man4/sd.4:79
8539 msgid "Returns the BIOS disk parameters in the following structure:"
8543 #: build/C/man4/sd.4:88
8546 "struct hd_geometry {\n"
8547 " unsigned char heads;\n"
8548 " unsigned char sectors;\n"
8549 " unsigned short cylinders;\n"
8550 " unsigned long start;\n"
8555 #: build/C/man4/sd.4:94
8556 msgid "A pointer to this structure is passed as the B<ioctl>(2) parameter."
8560 #: build/C/man4/sd.4:109
8562 "The information returned in the parameter is the disk geometry of the drive "
8563 "I<as understood by DOS!> This geometry is I<not> the physical geometry of "
8564 "the drive. It is used when constructing the drive's partition table, "
8565 "however, and is needed for convenient operation of B<fdisk>(1), "
8566 "B<efdisk>(1), and B<lilo>(1). If the geometry information is not available, "
8567 "zero will be returned for all of the parameters."
8571 #: build/C/man4/sd.4:110
8573 msgid "B<BLKGETSIZE>"
8577 #: build/C/man4/sd.4:117
8579 "Returns the device size in sectors. The B<ioctl>(2) parameter should be a "
8580 "pointer to a I<long>."
8584 #: build/C/man4/sd.4:117
8586 msgid "B<BLKRRPART>"
8590 #: build/C/man4/sd.4:121
8591 msgid "Forces a reread of the SCSI disk partition tables. No parameter is needed."
8595 #: build/C/man4/sd.4:131
8597 "The SCSI B<ioctl>(2) operations are also supported. If the B<ioctl>(2) "
8598 "parameter is required, and it is NULL, then B<ioctl>(2) will fail with the "
8603 #: build/C/man4/sd.4:133
8604 msgid "/dev/sd[a-h]: the whole device"
8610 #: build/C/man4/sd.4:137
8611 msgid "/dev/sd[a-h][0-8]: individual block partitions"
8615 #: build/C/man3/setlogmask.3:25
8621 #: build/C/man3/setlogmask.3:25
8627 #: build/C/man3/setlogmask.3:28
8628 msgid "setlogmask - set log priority mask"
8632 #: build/C/man3/setlogmask.3:31
8634 msgid "B<#include E<lt>syslog.hE<gt>>\n"
8638 #: build/C/man3/setlogmask.3:33
8640 msgid "B<int setlogmask(int >I<mask>B<);>\n"
8644 #: build/C/man3/setlogmask.3:43
8646 "A process has a log priority mask that determines which calls to "
8647 "B<syslog>(3) may be logged. All other calls will be ignored. Logging is "
8648 "enabled for the priorities that have the corresponding bit set in I<mask>. "
8649 "The initial mask is such that logging is enabled for all priorities."
8653 #: build/C/man3/setlogmask.3:49
8655 "The B<setlogmask>() function sets this logmask for the calling process, and "
8656 "returns the previous mask. If the mask argument is 0, the current logmask "
8661 #: build/C/man3/setlogmask.3:69
8663 "The eight priorities are B<LOG_EMERG>, B<LOG_ALERT>, B<LOG_CRIT>, "
8664 "B<LOG_ERR>, B<LOG_WARNING>, B<LOG_NOTICE>, B<LOG_INFO>, and B<LOG_DEBUG>. "
8665 "The bit corresponding to a priority I<p> is I<LOG_MASK(p)>. Some systems "
8666 "also provide a macro I<LOG_UPTO(p)> for the mask of all priorities in the "
8667 "above list up to and including I<p>."
8671 #: build/C/man3/setlogmask.3:71
8672 msgid "This function returns the previous log priority mask."
8676 #. The glibc logmask handling was broken in versions before glibc 2.1.1.
8678 #: build/C/man3/setlogmask.3:75
8683 #: build/C/man3/setlogmask.3:78
8684 msgid "POSIX.1-2001. Note that the description in POSIX.1-2001 is flawed."
8688 #: build/C/man3/setlogmask.3:82
8689 msgid "B<closelog>(3), B<openlog>(3), B<syslog>(3)"
8693 #: build/C/man4/sk98lin.4:27
8699 #: build/C/man4/sk98lin.4:30
8700 msgid "sk98lin - Marvell/SysKonnect Gigabit Ethernet driver v6.21"
8704 #: build/C/man4/sk98lin.4:62
8706 "B<insmod sk98lin.o> [B<Speed_A=>I<i,j,...>] [B<Speed_B=>I<i,j,...>] "
8707 "[B<AutoNeg_A=>I<i,j,...>] [B<AutoNeg_B=>I<i,j,...>] [B<DupCap_A=>I<i,j,...>] "
8708 "[B<DupCap_B=>I<i,j,...>] [B<FlowCtrl_A=>I<i,j,...>] "
8709 "[B<FlowCtrl_B=>I<i,j,...>] [B<Role_A=>I<i,j,...>] [B<Role_B=>I<i,j,...>] "
8710 "[B<ConType=>I<i,j,...>] [B<Moderation=>I<i,j,...>] "
8711 "[B<IntsPerSec=>I<i,j,...>] [B<PrefPort=>I<i,j,...>] [B<RlmtMode=>I<i,j,...>]"
8715 #: build/C/man4/sk98lin.4:67
8716 msgid "B<Note>: This obsolete driver was removed from the kernel in version 2.6.26."
8720 #: build/C/man4/sk98lin.4:74
8722 "B<sk98lin> is the Gigabit Ethernet driver for Marvell and SysKonnect network "
8723 "adapter cards. It supports SysKonnect SK-98xx/SK-95xx compliant Gigabit "
8724 "Ethernet Adapter and any Yukon compliant chipset."
8728 #: build/C/man4/sk98lin.4:81
8730 "When loading the driver using insmod, parameters for the network adapter "
8731 "cards might be stated as a sequence of comma separated commands. If for "
8732 "instance two network adapters are installed and AutoNegotiation on Port A of "
8733 "the first adapter should be ON, but on the Port A of the second adapter "
8734 "switched OFF, one must enter:"
8738 #: build/C/man4/sk98lin.4:83
8740 msgid " insmod sk98lin.o AutoNeg_A=On,Off\n"
8744 #: build/C/man4/sk98lin.4:98
8746 "After B<sk98lin> is bound to one or more adapter cards and the I</proc> "
8747 "filesystem is mounted on your system, a dedicated statistics file will be "
8748 "created in the folder I</proc/net/sk98lin> for all ports of the installed "
8749 "network adapter cards. Those files are named I<eth[x]> whereas I<x> is the "
8750 "number of the interface that has been assigned to a dedicated port by the "
8755 #: build/C/man4/sk98lin.4:108
8757 "If loading is finished, any desired IP address can be assigned to the "
8758 "respective I<eth[x]> interface using the B<ifconfig>(8) command. This "
8759 "causes the adapter to connect to the Ethernet and to display a status "
8760 "message on the console saying \"ethx: network connection up using port y\" "
8761 "followed by the configured or detected connection parameters."
8765 #: build/C/man4/sk98lin.4:124
8767 "The B<sk98lin> also supports large frames (also called jumbo frames). Using "
8768 "jumbo frames can improve throughput tremendously when transferring large "
8769 "amounts of data. To enable large frames, the MTU (maximum transfer unit) "
8770 "size for an interface is to be set to a high value. The default MTU size is "
8771 "1500 and can be changed up to 9000 (bytes). Setting the MTU size can be "
8772 "done when assigning the IP address to the interface or later by using the "
8773 "B<ifconfig>(8) command with the mtu parameter. If for instance eth0 needs "
8774 "an IP address and a large frame MTU size, the following two commands might "
8779 #: build/C/man4/sk98lin.4:127
8782 " ifconfig eth0 10.1.1.1\n"
8783 " ifconfig eth0 mtu 9000\n"
8787 #: build/C/man4/sk98lin.4:129
8788 msgid "Those two commands might even be combined into one:"
8792 #: build/C/man4/sk98lin.4:131
8794 msgid " ifconfig eth0 10.1.1.1 mtu 9000\n"
8798 #: build/C/man4/sk98lin.4:144
8800 "Note that large frames can be used only if permitted by your network "
8801 "infrastructure. This means, that any switch being used in your Ethernet "
8802 "must also support large frames. Quite some switches support large frames, "
8803 "but need to be configured to do so. Most of the times, their default "
8804 "setting is to support only standard frames with an MTU size of 1500 "
8805 "(bytes). In addition to the switches inside the network, all network "
8806 "adapters that are to be used must also be enabled regarding jumbo frames. "
8807 "If an adapter is not set to receive large frames it will simply drop them."
8811 #: build/C/man4/sk98lin.4:148
8813 "Switching back to the standard Ethernet frame size can be done by using the "
8814 "B<ifconfig>(8) command again:"
8818 #: build/C/man4/sk98lin.4:150
8820 msgid " ifconfig eth0 mtu 1500\n"
8824 #: build/C/man4/sk98lin.4:156
8826 "The Marvell/SysKonnect Gigabit Ethernet driver for Linux is able to support "
8827 "VLAN and Link Aggregation according to IEEE standards 802.1, 802.1q, and "
8828 "802.3ad. Those features are available only after installation of open "
8829 "source modules which can be found on the Internet:"
8833 #: build/C/man4/sk98lin.4:161
8834 msgid "I<VLAN>: E<.UR http://www.candelatech.com\\:/~greear\\:/vlan.html> E<.UE>"
8838 #: build/C/man4/sk98lin.4:167
8839 msgid "I<Link> I<Aggregation>: E<.UR http://www.st.rim.or.jp\\:/~yumo> E<.UE>"
8843 #: build/C/man4/sk98lin.4:172
8845 "Note that Marvell/SysKonnect does not offer any support for these open "
8846 "source modules and does not take the responsibility for any kind of failures "
8847 "or problems arising when using these modules."
8851 #: build/C/man4/sk98lin.4:172 build/C/man4/wavelan.4:39
8857 #: build/C/man4/sk98lin.4:173
8859 msgid "B<Speed_A=>I<i,j,...>"
8863 #: build/C/man4/sk98lin.4:191
8865 "This parameter is used to set the speed capabilities of port A of an adapter "
8866 "card. It is valid only for Yukon copper adapters. Possible values are: "
8867 "I<10>, I<100>, I<1000> or I<Auto> whereas I<Auto> is the default. Usually, "
8868 "the speed is negotiated between the two ports during link establishment. If "
8869 "this fails, a port can be forced to a specific setting with this parameter."
8873 #: build/C/man4/sk98lin.4:191
8875 msgid "B<Speed_B=>I<i,j,...>"
8879 #: build/C/man4/sk98lin.4:209
8881 "This parameter is used to set the speed capabilities of port B of an adapter "
8882 "card. It is valid only for Yukon copper adapters. Possible values are: "
8883 "I<10>, I<100>, I<1000> or I<Auto> whereas I<Auto> is the default. Usually, "
8884 "the speed is negotiated between the two ports during link establishment. If "
8885 "this fails, a port can be forced to a specific setting with this parameter."
8889 #: build/C/man4/sk98lin.4:209
8891 msgid "B<AutoNeg_A=>I<i,j,...>"
8895 #: build/C/man4/sk98lin.4:224
8897 "Enables or disables the use of autonegotiation of port A of an adapter "
8898 "card. Possible values are: I<On>, I<Off> or I<Sense> whereas I<On> is the "
8899 "default. The I<Sense> mode automatically detects whether the link partner "
8900 "supports auto-negotiation or not."
8904 #: build/C/man4/sk98lin.4:224
8906 msgid "B<AutoNeg_B=>I<i,j,...>"
8910 #: build/C/man4/sk98lin.4:239
8912 "Enables or disables the use of autonegotiation of port B of an adapter "
8913 "card. Possible values are: I<On>, I<Off> or I<Sense> whereas I<On> is the "
8914 "default. The I<Sense> mode automatically detects whether the link partner "
8915 "supports auto-negotiation or not."
8919 #: build/C/man4/sk98lin.4:239
8921 msgid "B<DupCap_A=>I<i,j,...>"
8925 #: build/C/man4/sk98lin.4:270
8927 "This parameter indicates the duplex mode to be used for port A of an adapter "
8928 "card. Possible values are: I<Half>, I<Full> or I<Both> whereas I<Both> is "
8929 "the default. This parameter is relevant only if AutoNeg_A of port A is not "
8930 "set to I<Sense>. If AutoNeg_A is set to I<On>, all three values of DupCap_A "
8931 "( I<Half>, I<Full> or I<Both>) might be stated. If AutoNeg_A is set to "
8932 "I<Off>, only DupCap_A values I<Full> and I<Half> are allowed. This DupCap_A "
8933 "parameter is useful if your link partner does not support all possible "
8934 "duplex combinations."
8938 #: build/C/man4/sk98lin.4:270
8940 msgid "B<DupCap_B=>I<i,j,...>"
8944 #: build/C/man4/sk98lin.4:301
8946 "This parameter indicates the duplex mode to be used for port B of an adapter "
8947 "card. Possible values are: I<Half>, I<Full> or I<Both> whereas I<Both> is "
8948 "the default. This parameter is relevant only if AutoNeg_B of port B is not "
8949 "set to I<Sense>. If AutoNeg_B is set to I<On>, all three values of DupCap_B "
8950 "( I<Half>, I<Full> or I<Both>) might be stated. If AutoNeg_B is set to "
8951 "I<Off>, only DupCap_B values I<Full> and I<Half> are allowed. This DupCap_B "
8952 "parameter is useful if your link partner does not support all possible "
8953 "duplex combinations."
8957 #: build/C/man4/sk98lin.4:301
8959 msgid "B<FlowCtrl_A=>I<i,j,...>"
8963 #: build/C/man4/sk98lin.4:315 build/C/man4/sk98lin.4:349
8965 "This parameter can be used to set the flow control capabilities the port "
8966 "reports during auto-negotiation. Possible values are: I<Sym>, I<SymOrRem>, "
8967 "I<LocSend> or I<None> whereas I<SymOrRem> is the default. The different "
8968 "modes have the following meaning:"
8972 #: build/C/man4/sk98lin.4:320 build/C/man4/sk98lin.4:353
8977 " both link partners are allowed to send PAUSE frames\n"
8981 #: build/C/man4/sk98lin.4:324 build/C/man4/sk98lin.4:357
8985 "= SymmetricOrRemote\n"
8986 " both or only remote partner are allowed to send PAUSE frames\n"
8990 #: build/C/man4/sk98lin.4:328 build/C/man4/sk98lin.4:361
8995 " only local link partner is allowed to send PAUSE frames\n"
8999 #: build/C/man4/sk98lin.4:332 build/C/man4/sk98lin.4:365
9004 " no link partner is allowed to send PAUSE frames\n"
9008 #: build/C/man4/sk98lin.4:335
9009 msgid "Note that this parameter is ignored if AutoNeg_A is set to I<Off>."
9013 #: build/C/man4/sk98lin.4:335
9015 msgid "B<FlowCtrl_B=>I<i,j,...>"
9019 #: build/C/man4/sk98lin.4:369
9020 msgid "Note that this parameter is ignored if AutoNeg_B is set to I<Off>."
9024 #: build/C/man4/sk98lin.4:369
9026 msgid "B<Role_A=>I<i,j,...>"
9030 #: build/C/man4/sk98lin.4:386
9032 "This parameter is valid only for 1000Base-T adapter cards. For two "
9033 "1000Base-T ports to communicate, one must take the role of the master "
9034 "(providing timing information), while the other must be the slave. Possible "
9035 "values are: I<Auto>, I<Master> or I<Slave> whereas I<Auto> is the default. "
9036 "Usually, the role of a port is negotiated between two ports during link "
9037 "establishment, but if that fails the port A of an adapter card can be forced "
9038 "to a specific setting with this parameter."
9042 #: build/C/man4/sk98lin.4:386
9044 msgid "B<Role_B=>I<i,j,...>"
9048 #: build/C/man4/sk98lin.4:404
9050 "This parameter is valid only for 1000Base-T adapter cards. For two "
9051 "1000Base-T ports to communicate, one must take the role of the master "
9052 "(providing timing information), while the other must be the slave. Possible "
9053 "values are: I<Auto>, I<Master> or I<Slave> whereas I<Auto> is the default. "
9054 "Usually, the role of a port is negotiated between two ports during link "
9055 "establishment, but if that fails the port B of an adapter card can be forced "
9056 "to a specific setting with this parameter."
9060 #: build/C/man4/sk98lin.4:404
9062 msgid "B<ConType=>I<i,j,...>"
9066 #: build/C/man4/sk98lin.4:412
9068 "This parameter is a combination of all five per-port parameters within one "
9069 "single parameter. This simplifies the configuration of both ports of an "
9070 "adapter card. The different values of this variable reflect the most "
9071 "meaningful combinations of port parameters. Possible values and their "
9072 "corresponding combination of per-port parameters:"
9076 #: build/C/man4/sk98lin.4:417
9079 "ConType | DupCap AutoNeg FlowCtrl Role Speed\n"
9080 "--------+-------------------------------------------\n"
9081 "I<Auto> | Both On SymOrRem Auto Auto\n"
9085 #: build/C/man4/sk98lin.4:419
9087 msgid "I<100FD> | Full Off None Auto 100\n"
9091 #: build/C/man4/sk98lin.4:421
9093 msgid "I<100HD> | Half Off None Auto 100\n"
9097 #: build/C/man4/sk98lin.4:423
9099 msgid "I<10FD> | Full Off None Auto 10\n"
9103 #: build/C/man4/sk98lin.4:425
9105 msgid "I<10HD> | Half Off None Auto 10\n"
9109 #: build/C/man4/sk98lin.4:435
9111 "Stating any other port parameter together with this I<ConType> parameter "
9112 "will result in a merged configuration of those settings. This is due to the "
9113 "fact, that the per-port parameters (e.g., I<Speed_A>) have a higher "
9114 "priority than the combined variable I<ConType>."
9118 #: build/C/man4/sk98lin.4:435
9120 msgid "B<Moderation=>I<i,j,...>"
9124 #: build/C/man4/sk98lin.4:453
9126 "Interrupt moderation is employed to limit the maximum number of interrupts "
9127 "the driver has to serve. That is, one or more interrupts (which indicate "
9128 "any transmit or receive packet to be processed) are queued until the driver "
9129 "processes them. When queued interrupts are to be served, is determined by "
9130 "the I<IntsPerSec> parameter, which is explained later below. Possible "
9131 "moderation modes are: I<None>, I<Static> or I<Dynamic> whereas I<None> is "
9132 "the default. The different modes have the following meaning:"
9136 #: build/C/man4/sk98lin.4:458
9138 "I<None> No interrupt moderation is applied on the adapter card. Therefore, "
9139 "each transmit or receive interrupt is served immediately as soon as it "
9140 "appears on the interrupt line of the adapter card."
9144 #: build/C/man4/sk98lin.4:473
9146 "I<Static> Interrupt moderation is applied on the adapter card. All transmit "
9147 "and receive interrupts are queued until a complete moderation interval "
9148 "ends. If such a moderation interval ends, all queued interrupts are "
9149 "processed in one big bunch without any delay. The term I<Static> reflects "
9150 "the fact, that interrupt moderation is always enabled, regardless how much "
9151 "network load is currently passing via a particular interface. In addition, "
9152 "the duration of the moderation interval has a fixed length that never "
9153 "changes while the driver is operational."
9157 #: build/C/man4/sk98lin.4:484
9159 "I<Dynamic> Interrupt moderation might be applied on the adapter card, "
9160 "depending on the load of the system. If the driver detects that the system "
9161 "load is too high, the driver tries to shield the system against too much "
9162 "network load by enabling interrupt moderation. If\\(emat a later "
9163 "time\\(emthe CPU utilization decreases again (or if the network load is "
9164 "negligible) the interrupt moderation will automatically be disabled."
9168 #: build/C/man4/sk98lin.4:490
9170 "Interrupt moderation should be used when the driver has to handle one or "
9171 "more interfaces with a high network load, which\\(emas a "
9172 "consequence\\(emleads also to a high CPU utilization. When moderation is "
9173 "applied in such high network load situations, CPU load might be reduced by "
9174 "20-30% on slow computers."
9178 #: build/C/man4/sk98lin.4:494
9180 "Note that the drawback of using interrupt moderation is an increase of the "
9181 "round-trip-time (RTT), due to the queuing and serving of interrupts at "
9182 "dedicated moderation times."
9186 #: build/C/man4/sk98lin.4:494
9188 msgid "B<IntsPerSec=>I<i,j,...>"
9192 #: build/C/man4/sk98lin.4:504
9194 "This parameter determines the length of any interrupt moderation interval. "
9195 "Assuming that static interrupt moderation is to be used, an I<IntsPerSec> "
9196 "parameter value of 2000 will lead to an interrupt moderation interval of 500 "
9197 "microseconds. Possible values for this parameter are in the range of "
9198 "30...40000 (interrupts per second). The default value is 2000."
9202 #: build/C/man4/sk98lin.4:508
9204 "This parameter is used only if either static or dynamic interrupt moderation "
9205 "is enabled on a network adapter card. This parameter is ignored if no "
9206 "moderation is applied."
9210 #: build/C/man4/sk98lin.4:515
9212 "Note that the duration of the moderation interval is to be chosen with "
9213 "care. At first glance, selecting a very long duration (e.g., only 100 "
9214 "interrupts per second) seems to be meaningful, but the increase of "
9215 "packet-processing delay is tremendous. On the other hand, selecting a very "
9216 "short moderation time might compensate the use of any moderation being "
9221 #: build/C/man4/sk98lin.4:515
9223 msgid "B<PrefPort=>I<i,j,...>"
9227 #: build/C/man4/sk98lin.4:528
9229 "This parameter is used to force the preferred port to A or B (on dual-port "
9230 "network adapters). The preferred port is the one that is used if both ports "
9231 "A and B are detected as fully functional. Possible values are: I<A> or I<B> "
9232 "whereas I<A> is the default."
9236 #: build/C/man4/sk98lin.4:528
9238 msgid "B<RlmtMode=>I<i,j,...>"
9242 #: build/C/man4/sk98lin.4:545
9244 "RLMT monitors the status of the port. If the link of the active port fails, "
9245 "RLMT switches immediately to the standby link. The virtual link is "
9246 "maintained as long as at least one \"physical\" link is up. This parameters "
9247 "states how RLMT should monitor both ports. Possible values are: "
9248 "I<CheckLinkState>, I<CheckLocalPort>, I<CheckSeg> or I<DualNet> whereas "
9249 "I<CheckLinkState> is the default. The different modes have the following "
9254 #: build/C/man4/sk98lin.4:550
9256 "I<CheckLinkState> Check link state only: RLMT uses the link state reported "
9257 "by the adapter hardware for each individual port to determine whether a port "
9258 "can be used for all network traffic or not."
9262 #: build/C/man4/sk98lin.4:558
9264 "I<CheckLocalPort> In this mode, RLMT monitors the network path between the "
9265 "two ports of an adapter by regularly exchanging packets between them. This "
9266 "mode requires a network configuration in which the two ports are able to "
9267 "\"see\" each other (i.e., there must not be any router between the ports)."
9271 #: build/C/man4/sk98lin.4:567
9273 "I<CheckSeg> Check local port and segmentation: This mode supports the same "
9274 "functions as the CheckLocalPort mode and additionally checks network "
9275 "segmentation between the ports. Therefore, this mode is to be used only if "
9276 "Gigabit Ethernet switches are installed on the network that have been "
9277 "configured to use the Spanning Tree protocol."
9281 #: build/C/man4/sk98lin.4:578
9283 "I<DualNet> In this mode, ports A and B are used as separate devices. If you "
9284 "have a dual port adapter, port A will be configured as I<eth[x]> and port B "
9285 "as I<eth[x+1]>. Both ports can be used independently with distinct IP "
9286 "addresses. The preferred port setting is not used. RLMT is turned off."
9290 #: build/C/man4/sk98lin.4:587
9292 "Note that RLMT modes I<CheckLocalPort> and I<CheckLinkState> are designed to "
9293 "operate in configurations where a network path between the ports on one "
9294 "adapter exists. Moreover, they are not designed to work where adapters are "
9295 "connected back-to-back."
9299 #: build/C/man4/sk98lin.4:588
9301 msgid "I</proc/net/sk98lin/eth[x]>"
9305 #: build/C/man4/sk98lin.4:594
9307 "The statistics file of a particular interface of an adapter card. It "
9308 "contains generic information about the adapter card plus a detailed summary "
9309 "of all transmit and receive counters."
9313 #: build/C/man4/sk98lin.4:594
9315 msgid "I</usr/src/linux/Documentation/networking/sk98lin.txt>"
9319 #: build/C/man4/sk98lin.4:605
9321 "This is the I<README> file of the I<sk98lin> driver. It contains a detailed "
9322 "installation HOWTO and describes all parameters of the driver. It denotes "
9323 "also common problems and provides the solution to them."
9327 #. Ralph Roesler \(em rroesler@syskonnect.de
9329 #. Mirko Lindner \(em mlindner@syskonnect.de
9331 #: build/C/man4/sk98lin.4:611
9332 msgid "Report any bugs to linux@syskonnect.de"
9336 #: build/C/man4/sk98lin.4:615
9337 msgid "B<ifconfig>(8), B<insmod>(8), B<modprobe>(8)"
9341 #: build/C/man4/st.4:25
9347 #: build/C/man4/st.4:28
9348 msgid "st - SCSI tape device"
9352 #: build/C/man4/st.4:31
9354 msgid "B<#include E<lt>sys/mtio.hE<gt>>\n"
9358 #: build/C/man4/st.4:36
9361 "B<int ioctl(int >I<fd>B<, int >I<request>B< [, (void *)>I<arg3>B<]);>\n"
9362 "B<int ioctl(int >I<fd>B<, MTIOCTOP, (struct mtop *)>I<mt_cmd>B<);>\n"
9363 "B<int ioctl(int >I<fd>B<, MTIOCGET, (struct mtget *)>I<mt_status>B<);>\n"
9364 "B<int ioctl(int >I<fd>B<, MTIOCPOS, (struct mtpos *)>I<mt_pos>B<);>\n"
9368 #: build/C/man4/st.4:46
9370 "The B<st> driver provides the interface to a variety of SCSI tape devices. "
9371 "Currently, the driver takes control of all detected devices of type "
9372 "\\(lqsequential-access\\(rq. The B<st> driver uses major device number 9."
9376 #: build/C/man4/st.4:66
9378 "Each device uses eight minor device numbers. The lowermost five bits in the "
9379 "minor numbers are assigned sequentially in the order of detection. In the "
9380 "2.6 kernel, the bits above the eight lowermost bits are concatenated to the "
9381 "five lowermost bits to form the tape number. The minor numbers can be "
9382 "grouped into two sets of four numbers: the principal (auto-rewind) minor "
9383 "device numbers, I<n>, and the \\(lqno-rewind\\(rq device numbers, (I<n> + "
9384 "128). Devices opened using the principal device number will be sent a "
9385 "B<REWIND> command when they are closed. Devices opened using the "
9386 "\\(lqno-rewind\\(rq device number will not. (Note that using an auto-rewind "
9387 "device for positioning the tape with, for instance, mt does not lead to the "
9388 "desired result: the tape is rewound after the mt command and the next "
9389 "command starts from the beginning of the tape)."
9393 #: build/C/man4/st.4:80
9395 "Within each group, four minor numbers are available to define devices with "
9396 "different characteristics (block size, compression, density, etc.) When the "
9397 "system starts up, only the first device is available. The other three are "
9398 "activated when the default characteristics are defined (see below). (By "
9399 "changing compile-time constants, it is possible to change the balance "
9400 "between the maximum number of tape drives and the number of minor numbers "
9401 "for each drive. The default allocation allows control of 32 tape drives. "
9402 "For instance, it is possible to control up to 64 tape drives with two minor "
9403 "numbers for different options.)"
9407 #: build/C/man4/st.4:82
9408 msgid "Devices are typically created by:"
9412 #: build/C/man4/st.4:93
9415 "mknod -m 666 /dev/st0 c 9 0\n"
9416 "mknod -m 666 /dev/st0l c 9 32\n"
9417 "mknod -m 666 /dev/st0m c 9 64\n"
9418 "mknod -m 666 /dev/st0a c 9 96\n"
9419 "mknod -m 666 /dev/nst0 c 9 128\n"
9420 "mknod -m 666 /dev/nst0l c 9 160\n"
9421 "mknod -m 666 /dev/nst0m c 9 192\n"
9422 "mknod -m 666 /dev/nst0a c 9 224\n"
9426 #: build/C/man4/st.4:97
9427 msgid "There is no corresponding block device."
9431 #: build/C/man4/st.4:112
9433 "The driver uses an internal buffer that has to be large enough to hold at "
9434 "least one tape block. In kernels before 2.1.121, the buffer is allocated as "
9435 "one contiguous block. This limits the block size to the largest contiguous "
9436 "block of memory the kernel allocator can provide. The limit is currently "
9437 "128 kB for 32-bit architectures and 256 kB for 64-bit architectures. In "
9438 "newer kernels the driver allocates the buffer in several parts if "
9439 "necessary. By default, the maximum number of parts is 16. This means that "
9440 "the maximum block size is very large (2 MB if allocation of 16 blocks of 128 "
9445 #: build/C/man4/st.4:121
9447 "The driver's internal buffer size is determined by a compile-time constant "
9448 "which can be overridden with a kernel startup option. In addition to this, "
9449 "the driver tries to allocate a larger temporary buffer at run time if "
9450 "necessary. However, run-time allocation of large contiguous blocks of "
9451 "memory may fail and it is advisable not to rely too much on dynamic buffer "
9452 "allocation with kernels older than 2.1.121 (this applies also to "
9453 "demand-loading the driver with kerneld or kmod)."
9457 #: build/C/man4/st.4:134
9459 "The driver does not specifically support any tape drive brand or model. "
9460 "After system start-up the tape device options are defined by the drive "
9461 "firmware. For example, if the drive firmware selects fixed-block mode, the "
9462 "tape device uses fixed-block mode. The options can be changed with explicit "
9463 "B<ioctl>(2) calls and remain in effect when the device is closed and "
9464 "reopened. Setting the options affects both the auto-rewind and the "
9469 #: build/C/man4/st.4:143
9471 "Different options can be specified for the different devices within the "
9472 "subgroup of four. The options take effect when the device is opened. For "
9473 "example, the system administrator can define one device that writes in "
9474 "fixed-block mode with a certain block size, and one which writes in "
9475 "variable-block mode (if the drive supports both modes)."
9479 #: build/C/man4/st.4:166
9481 "The driver supports B<tape partitions> if they are supported by the drive. "
9482 "(Note that the tape partitions have nothing to do with disk partitions. A "
9483 "partitioned tape can be seen as several logical tapes within one medium.) "
9484 "Partition support has to be enabled with an B<ioctl>(2). The tape location "
9485 "is preserved within each partition across partition changes. The partition "
9486 "used for subsequent tape operations is selected with an B<ioctl>(2). The "
9487 "partition switch is executed together with the next tape operation in order "
9488 "to avoid unnecessary tape movement. The maximum number of partitions on a "
9489 "tape is defined by a compile-time constant (originally four). The driver "
9490 "contains an B<ioctl>(2) that can format a tape with either one or two "
9495 #: build/C/man4/st.4:171
9497 "Device I</dev/tape> is usually created as a hard or soft link to the default "
9498 "tape device on the system."
9502 #: build/C/man4/st.4:175
9504 "Starting from kernel 2.6.2, the driver exports in the sysfs directory "
9505 "I</sys/class/scsi_tape> the attached devices and some parameters assigned to "
9510 #: build/C/man4/st.4:175
9512 msgid "Data transfer"
9516 #: build/C/man4/st.4:188
9518 "The driver supports operation in both fixed-block mode and variable-block "
9519 "mode (if supported by the drive). In fixed-block mode the drive writes "
9520 "blocks of the specified size and the block size is not dependent on the byte "
9521 "counts of the write system calls. In variable-block mode one tape block is "
9522 "written for each write call and the byte count determines the size of the "
9523 "corresponding tape block. Note that the blocks on the tape don't contain "
9524 "any information about the writing mode: when reading, the only important "
9525 "thing is to use commands that accept the block sizes on the tape."
9529 #: build/C/man4/st.4:197
9531 "In variable-block mode the read byte count does not have to match the tape "
9532 "block size exactly. If the byte count is larger than the next block on "
9533 "tape, the driver returns the data and the function returns the actual block "
9534 "size. If the block size is larger than the byte count, the requested amount "
9535 "of data from the start of the block is returned and the rest of the block is "
9540 #: build/C/man4/st.4:206
9542 "In fixed-block mode the read byte counts can be arbitrary if buffering is "
9543 "enabled, or a multiple of the tape block size if buffering is disabled. "
9544 "Kernels before 2.1.121 allow writes with arbitrary byte count if buffering "
9545 "is enabled. In all other cases (kernel before 2.1.121 with buffering "
9546 "disabled or newer kernel) the write byte count must be a multiple of the "
9551 #: build/C/man4/st.4:215
9553 "In the 2.6 kernel, the driver tries to use direct transfers between the user "
9554 "buffer and the device. If this is not possible, the driver's internal "
9555 "buffer is used. The reasons for not using direct transfers include improper "
9556 "alignment of the user buffer (default is 512 bytes but this can be changed "
9557 "by the HBA driver), one of more pages of the user buffer not reachable by "
9558 "the SCSI adapter, etc."
9562 #: build/C/man4/st.4:218
9564 "A filemark is automatically written to tape if the last tape operation "
9565 "before close was a write."
9569 #: build/C/man4/st.4:230
9571 "When a filemark is encountered while reading, the following happens. If "
9572 "there are data remaining in the buffer when the filemark is found, the "
9573 "buffered data is returned. The next read returns zero bytes. The following "
9574 "read returns data from the next file. The end of recorded data is signaled "
9575 "by returning zero bytes for two consecutive read calls. The third read "
9580 #: build/C/man4/st.4:230
9586 #: build/C/man4/st.4:241
9588 "The driver supports three B<ioctl>(2) requests. Requests not recognized by "
9589 "the B<st> driver are passed to the B<SCSI> driver. The definitions below "
9590 "are from I</usr/include/linux/mtio.h>:"
9594 #: build/C/man4/st.4:241
9596 msgid "MTIOCTOP \\(em perform a tape operation"
9600 #: build/C/man4/st.4:249
9602 "This request takes an argument of type I<(struct mtop\\ *)>. Not all drives "
9603 "support all operations. The driver returns an B<EIO> error if the drive "
9604 "rejects an operation."
9608 #: build/C/man4/st.4:257
9611 "/* Structure for MTIOCTOP - mag tape op command: */\n"
9613 " short mt_op; /* operations defined below */\n"
9614 " int mt_count; /* how many of them */\n"
9619 #: build/C/man4/st.4:261
9620 msgid "Magnetic Tape operations for normal tape use:"
9624 #: build/C/man4/st.4:261
9630 #: build/C/man4/st.4:266
9631 msgid "Backward space over I<mt_count> filemarks."
9635 #: build/C/man4/st.4:266
9641 #: build/C/man4/st.4:272
9643 "Backward space over I<mt_count> filemarks. Reposition the tape to the EOT "
9644 "side of the last filemark."
9648 #: build/C/man4/st.4:272
9654 #: build/C/man4/st.4:277
9655 msgid "Backward space over I<mt_count> records (tape blocks)."
9659 #: build/C/man4/st.4:277
9665 #: build/C/man4/st.4:282
9666 msgid "Backward space over I<mt_count> setmarks."
9670 #: build/C/man4/st.4:282
9672 msgid "B<MTCOMPRESSION>"
9676 #: build/C/man4/st.4:290
9678 "Enable compression of tape data within the drive if I<mt_count> is nonzero "
9679 "and disable compression if I<mt_count> is zero. This command uses the MODE "
9680 "page 15 supported by most DATs."
9684 #: build/C/man4/st.4:290
9690 #: build/C/man4/st.4:293
9691 msgid "Go to the end of the recorded media (for appending files)."
9695 #: build/C/man4/st.4:293
9701 #: build/C/man4/st.4:299
9703 "Erase tape. With 2.6 kernel, short erase (mark tape empty) is performed if "
9704 "the argument is zero. Otherwise long erase (erase all) is done."
9708 #: build/C/man4/st.4:299
9714 #: build/C/man4/st.4:304
9715 msgid "Forward space over I<mt_count> filemarks."
9719 #: build/C/man4/st.4:304
9725 #: build/C/man4/st.4:310
9727 "Forward space over I<mt_count> filemarks. Reposition the tape to the BOT "
9728 "side of the last filemark."
9732 #: build/C/man4/st.4:310
9738 #: build/C/man4/st.4:315
9739 msgid "Forward space over I<mt_count> records (tape blocks)."
9743 #: build/C/man4/st.4:315
9749 #: build/C/man4/st.4:320
9750 msgid "Forward space over I<mt_count> setmarks."
9754 #: build/C/man4/st.4:320
9760 #: build/C/man4/st.4:331
9762 "Execute the SCSI load command. A special case is available for some HP "
9763 "autoloaders. If I<mt_count> is the constant B<MT_ST_HPLOADER_OFFSET> plus a "
9764 "number, the number is sent to the drive to control the autoloader."
9768 #: build/C/man4/st.4:331
9774 #: build/C/man4/st.4:334
9775 msgid "Lock the tape drive door."
9779 #: build/C/man4/st.4:334
9785 #: build/C/man4/st.4:348
9787 "Format the tape into one or two partitions. If I<mt_count> is nonzero, it "
9788 "gives the size of the first partition and the second partition contains the "
9789 "rest of the tape. If I<mt_count> is zero, the tape is formatted into one "
9790 "partition. This command is not allowed for a drive unless the partition "
9791 "support is enabled for the drive (see B<MT_ST_CAN_PARTITIONS> below)."
9795 #: build/C/man4/st.4:348
9801 #: build/C/man4/st.4:353
9803 "No op\\(emflushes the driver's buffer as a side effect. Should be used "
9804 "before reading status with B<MTIOCGET>."
9808 #: build/C/man4/st.4:353
9814 #: build/C/man4/st.4:356
9815 msgid "Rewind and put the drive off line."
9819 #: build/C/man4/st.4:356
9825 #: build/C/man4/st.4:359
9826 msgid "Reset drive."
9830 #: build/C/man4/st.4:359
9836 #: build/C/man4/st.4:362
9837 msgid "Re-tension tape."
9841 #: build/C/man4/st.4:362
9847 #: build/C/man4/st.4:365
9852 #: build/C/man4/st.4:365
9858 #: build/C/man4/st.4:377
9860 "Seek to the tape block number specified in I<mt_count>. This operation "
9861 "requires either a SCSI-2 drive that supports the B<LOCATE> command "
9862 "(device-specific address) or a Tandberg-compatible SCSI-1 drive (Tandberg, "
9863 "Archive Viper, Wangtek, ...). The block number should be one that was "
9864 "previously returned by B<MTIOCPOS> if device-specific addresses are used."
9868 #: build/C/man4/st.4:377
9874 #: build/C/man4/st.4:382
9876 "Set the drive's block length to the value specified in I<mt_count>. A block "
9877 "length of zero sets the drive to variable block size mode."
9881 #: build/C/man4/st.4:382
9883 msgid "B<MTSETDENSITY>"
9887 #: build/C/man4/st.4:388
9889 "Set the tape density to the code in I<mt_count>. The density codes "
9890 "supported by a drive can be found from the drive documentation."
9894 #: build/C/man4/st.4:388
9896 msgid "B<MTSETPART>"
9900 #: build/C/man4/st.4:397
9902 "The active partition is switched to I<mt_count>. The partitions are "
9903 "numbered from zero. This command is not allowed for a drive unless the "
9904 "partition support is enabled for the drive (see B<MT_ST_CAN_PARTITIONS> "
9909 #: build/C/man4/st.4:397
9915 #: build/C/man4/st.4:400
9916 msgid "Execute the SCSI unload command (does not eject the tape)."
9920 #: build/C/man4/st.4:400
9926 #: build/C/man4/st.4:403
9927 msgid "Unlock the tape drive door."
9931 #: build/C/man4/st.4:403
9937 #: build/C/man4/st.4:408
9938 msgid "Write I<mt_count> filemarks."
9942 #: build/C/man4/st.4:408
9948 #: build/C/man4/st.4:413
9949 msgid "Write I<mt_count> setmarks."
9953 #: build/C/man4/st.4:415
9954 msgid "Magnetic Tape operations for setting of device options (by the superuser):"
9958 #: build/C/man4/st.4:415
9960 msgid "B<MTSETDRVBUFFER>"
9964 #: build/C/man4/st.4:424
9966 "Set various drive and driver options according to bits encoded in "
9967 "I<mt_count>. These consist of the drive's buffering mode, a set of Boolean "
9968 "driver options, the buffer write threshold, defaults for the block size and "
9969 "density, and timeouts (only in kernels 2.1 and later). A single operation "
9970 "can affect only one item in the list above (the Booleans counted as one "
9975 #: build/C/man4/st.4:428
9977 "A value having zeros in the high-order 4 bits will be used to set the "
9978 "drive's buffering mode. The buffering modes are:"
9982 #: build/C/man4/st.4:429
9988 #: build/C/man4/st.4:434
9990 "The drive will not report B<GOOD> status on write commands until the data "
9991 "blocks are actually written to the medium."
9995 #: build/C/man4/st.4:434
10000 #. type: Plain text
10001 #: build/C/man4/st.4:439
10003 "The drive may report B<GOOD> status on write commands as soon as all the "
10004 "data has been transferred to the drive's internal buffer."
10008 #: build/C/man4/st.4:439
10013 #. type: Plain text
10014 #: build/C/man4/st.4:446
10016 "The drive may report B<GOOD> status on write commands as soon as (a) all the "
10017 "data has been transferred to the drive's internal buffer, and (b) all "
10018 "buffered data from different initiators has been successfully written to the "
10022 #. type: Plain text
10023 #: build/C/man4/st.4:457
10025 "To control the write threshold the value in I<mt_count> must include the "
10026 "constant B<MT_ST_WRITE_THRESHOLD> bitwise ORed with a block count in the low "
10027 "28 bits. The block count refers to 1024-byte blocks, not the physical block "
10028 "size on the tape. The threshold cannot exceed the driver's internal buffer "
10029 "size (see DESCRIPTION, above)."
10032 #. type: Plain text
10033 #: build/C/man4/st.4:478
10035 "To set and clear the Boolean options the value in I<mt_count> must include "
10036 "one of the constants B<MT_ST_BOOLEANS>, B<MT_ST_SETBOOLEANS>, "
10037 "B<MT_ST_CLEARBOOLEANS>, or B<MT_ST_DEFBOOLEANS> bitwise ORed with whatever "
10038 "combination of the following options is desired. Using B<MT_ST_BOOLEANS> "
10039 "the options can be set to the values defined in the corresponding bits. "
10040 "With B<MT_ST_SETBOOLEANS> the options can be selectively set and with "
10041 "B<MT_ST_DEFBOOLEANS> selectively cleared."
10044 #. type: Plain text
10045 #: build/C/man4/st.4:486
10047 "The default options for a tape device are set with B<MT_ST_DEFBOOLEANS>. A "
10048 "nonactive tape device (e.g., device with minor 32 or 160) is activated when "
10049 "the default options for it are defined the first time. An activated device "
10050 "inherits from the device activated at start-up the options not set "
10054 #. type: Plain text
10055 #: build/C/man4/st.4:488
10056 msgid "The Boolean options are:"
10060 #: build/C/man4/st.4:489
10062 msgid "B<MT_ST_BUFFER_WRITES> (Default: true)"
10065 #. type: Plain text
10066 #: build/C/man4/st.4:495
10068 "Buffer all write operations in fixed-block mode. If this option is false "
10069 "and the drive uses a fixed block size, then all write operations must be for "
10070 "a multiple of the block size. This option must be set false to write "
10071 "reliable multivolume archives."
10075 #: build/C/man4/st.4:495
10077 msgid "B<MT_ST_ASYNC_WRITES> (Default: true)"
10080 #. type: Plain text
10081 #: build/C/man4/st.4:505
10083 "When this option is true, write operations return immediately without "
10084 "waiting for the data to be transferred to the drive if the data fits into "
10085 "the driver's buffer. The write threshold determines how full the buffer "
10086 "must be before a new SCSI write command is issued. Any errors reported by "
10087 "the drive will be held until the next operation. This option must be set "
10088 "false to write reliable multivolume archives."
10092 #: build/C/man4/st.4:505
10094 msgid "B<MT_ST_READ_AHEAD> (Default: true)"
10097 #. type: Plain text
10098 #: build/C/man4/st.4:511
10100 "This option causes the driver to provide read buffering and read-ahead in "
10101 "fixed-block mode. If this option is false and the drive uses a fixed block "
10102 "size, then all read operations must be for a multiple of the block size."
10106 #: build/C/man4/st.4:511
10108 msgid "B<MT_ST_TWO_FM> (Default: false)"
10111 #. type: Plain text
10112 #: build/C/man4/st.4:517
10114 "This option modifies the driver behavior when a file is closed. The normal "
10115 "action is to write a single filemark. If the option is true the driver will "
10116 "write two filemarks and backspace over the second one."
10119 #. type: Plain text
10120 #: build/C/man4/st.4:526
10122 "Note: This option should not be set true for QIC tape drives since they are "
10123 "unable to overwrite a filemark. These drives detect the end of recorded "
10124 "data by testing for blank tape rather than two consecutive filemarks. Most "
10125 "other current drives also detect the end of recorded data and using two "
10126 "filemarks is usually necessary only when interchanging tapes with some other "
10131 #: build/C/man4/st.4:526
10133 msgid "B<MT_ST_DEBUGGING> (Default: false)"
10136 #. type: Plain text
10137 #: build/C/man4/st.4:532
10139 "This option turns on various debugging messages from the driver (effective "
10140 "only if the driver was compiled with B<DEBUG> defined nonzero)."
10144 #: build/C/man4/st.4:532
10146 msgid "B<MT_ST_FAST_EOM> (Default: false)"
10149 #. type: Plain text
10150 #: build/C/man4/st.4:546
10152 "This option causes the B<MTEOM> operation to be sent directly to the drive, "
10153 "potentially speeding up the operation but causing the driver to lose track "
10154 "of the current file number normally returned by the B<MTIOCGET> request. If "
10155 "B<MT_ST_FAST_EOM> is false the driver will respond to an B<MTEOM> request by "
10156 "forward spacing over files."
10160 #: build/C/man4/st.4:546
10162 msgid "B<MT_ST_AUTO_LOCK> (Default: false)"
10165 #. type: Plain text
10166 #: build/C/man4/st.4:550
10168 "When this option is true, the drive door is locked when the device is opened "
10169 "and unlocked when it is closed."
10173 #: build/C/man4/st.4:550
10175 msgid "B<MT_ST_DEF_WRITES> (Default: false)"
10178 #. type: Plain text
10179 #: build/C/man4/st.4:567
10181 "The tape options (block size, mode, compression, etc.) may change when "
10182 "changing from one device linked to a drive to another device linked to the "
10183 "same drive depending on how the devices are defined. This option defines "
10184 "when the changes are enforced by the driver using SCSI-commands and when the "
10185 "drives auto-detection capabilities are relied upon. If this option is "
10186 "false, the driver sends the SCSI-commands immediately when the device is "
10187 "changed. If the option is true, the SCSI-commands are not sent until a "
10188 "write is requested. In this case the drive firmware is allowed to detect "
10189 "the tape structure when reading and the SCSI-commands are used only to make "
10190 "sure that a tape is written according to the correct specification."
10194 #: build/C/man4/st.4:567
10196 msgid "B<MT_ST_CAN_BSR> (Default: false)"
10199 #. type: Plain text
10200 #: build/C/man4/st.4:580
10202 "When read-ahead is used, the tape must sometimes be spaced backward to the "
10203 "correct position when the device is closed and the SCSI command to space "
10204 "backward over records is used for this purpose. Some older drives can't "
10205 "process this command reliably and this option can be used to instruct the "
10206 "driver not to use the command. The end result is that, with read-ahead and "
10207 "fixed-block mode, the tape may not be correctly positioned within a file "
10208 "when the device is closed. With 2.6 kernel, the default is true for drives "
10209 "supporting SCSI-3."
10213 #: build/C/man4/st.4:580
10215 msgid "B<MT_ST_NO_BLKLIMS> (Default: false)"
10218 #. type: Plain text
10219 #: build/C/man4/st.4:589
10221 "Some drives don't accept the B<READ BLOCK LIMITS> SCSI command. If this is "
10222 "used, the driver does not use the command. The drawback is that the driver "
10223 "can't check before sending commands if the selected block size is acceptable "
10228 #: build/C/man4/st.4:589
10230 msgid "B<MT_ST_CAN_PARTITIONS> (Default: false)"
10233 #. type: Plain text
10234 #: build/C/man4/st.4:594
10236 "This option enables support for several partitions within a tape. The "
10237 "option applies to all devices linked to a drive."
10241 #: build/C/man4/st.4:594
10243 msgid "B<MT_ST_SCSI2LOGICAL> (Default: false)"
10246 #. type: Plain text
10247 #: build/C/man4/st.4:609
10249 "This option instructs the driver to use the logical block addresses defined "
10250 "in the SCSI-2 standard when performing the seek and tell operations (both "
10251 "with B<MTSEEK> and B<MTIOCPOS> commands and when changing tape partition). "
10252 "Otherwise the device-specific addresses are used. It is highly advisable to "
10253 "set this option if the drive supports the logical addresses because they "
10254 "count also filemarks. There are some drives that support only the logical "
10259 #: build/C/man4/st.4:609
10261 msgid "B<MT_ST_SYSV> (Default: false)"
10264 #. type: Plain text
10265 #: build/C/man4/st.4:620
10267 "When this option is enabled, the tape devices use the SystemV semantics. "
10268 "Otherwise the BSD semantics are used. The most important difference between "
10269 "the semantics is what happens when a device used for reading is closed: in "
10270 "System V semantics the tape is spaced forward past the next filemark if this "
10271 "has not happened while using the device. In BSD semantics the tape position "
10276 #: build/C/man4/st.4:620
10278 msgid "B<MT_NO_WAIT> (Default: false)"
10281 #. type: Plain text
10282 #: build/C/man4/st.4:624
10284 "Enables immediate mode (i.e., don't wait for the command to finish) for some "
10285 "commands (e.g., rewind)."
10288 #. type: Plain text
10289 #: build/C/man4/st.4:626
10290 msgid "An example:"
10293 #. type: Plain text
10294 #: build/C/man4/st.4:634
10297 "struct mtop mt_cmd;\n"
10298 "mt_cmd.mt_op = MTSETDRVBUFFER;\n"
10299 "mt_cmd.mt_count = MT_ST_BOOLEANS |\n"
10300 " MT_ST_BUFFER_WRITES | MT_ST_ASYNC_WRITES;\n"
10301 "ioctl(fd, MTIOCTOP, mt_cmd);\n"
10304 #. type: Plain text
10305 #: build/C/man4/st.4:644
10307 "The default block size for a device can be set with B<MT_ST_DEF_BLKSIZE> and "
10308 "the default density code can be set with B<MT_ST_DEFDENSITY>. The values "
10309 "for the parameters are or'ed with the operation code."
10312 #. type: Plain text
10313 #: build/C/man4/st.4:661
10315 "With kernels 2.1.x and later, the timeout values can be set with the "
10316 "subcommand B<MT_ST_SET_TIMEOUT> ORed with the timeout in seconds. The long "
10317 "timeout (used for rewinds and other commands that may take a long time) can "
10318 "be set with B<MT_ST_SET_LONG_TIMEOUT>. The kernel defaults are very long to "
10319 "make sure that a successful command is not timed out with any drive. "
10320 "Because of this the driver may seem stuck even if it is only waiting for the "
10321 "timeout. These commands can be used to set more practical values for a "
10322 "specific drive. The timeouts set for one device apply for all devices "
10323 "linked to the same drive."
10326 #. type: Plain text
10327 #: build/C/man4/st.4:682
10329 "Starting from kernels 2.4.19 and 2.5.43, the driver supports a status bit "
10330 "which indicates whether the drive requests cleaning. The method used by the "
10331 "drive to return cleaning information is set using the B<MT_ST_SEL_CLN> "
10332 "subcommand. If the value is zero, the cleaning bit is always zero. If the "
10333 "value is one, the TapeAlert data defined in the SCSI-3 standard is used (not "
10334 "yet implemented). Values 2-17 are reserved. If the lowest eight bits are "
10335 "E<gt>= 18, bits from the extended sense data are used. The bits 9-16 "
10336 "specify a mask to select the bits to look at and the bits 17-23 specify the "
10337 "bit pattern to look for. If the bit pattern is zero, one or more bits under "
10338 "the mask indicate the cleaning request. If the pattern is nonzero, the "
10339 "pattern must match the masked sense data byte."
10343 #: build/C/man4/st.4:682
10345 msgid "MTIOCGET \\(em get status"
10348 #. type: Plain text
10349 #: build/C/man4/st.4:686
10350 msgid "This request takes an argument of type I<(struct mtget\\ *)>."
10353 #. type: Plain text
10354 #: build/C/man4/st.4:701
10357 "/* structure for MTIOCGET - mag tape get status command */\n"
10360 " long mt_resid;\n"
10361 " /* the following registers are device dependent */\n"
10362 " long mt_dsreg;\n"
10363 " long mt_gstat;\n"
10364 " long mt_erreg;\n"
10365 " /* The next two fields are not always used */\n"
10366 " daddr_t mt_fileno;\n"
10367 " daddr_t mt_blkno;\n"
10372 #: build/C/man4/st.4:703
10377 #. type: Plain text
10378 #: build/C/man4/st.4:712
10380 "The header file defines many values for I<mt_type>, but the current driver "
10381 "reports only the generic types B<MT_ISSCSI1> (Generic SCSI-1 tape) and "
10382 "B<MT_ISSCSI2> (Generic SCSI-2 tape)."
10386 #: build/C/man4/st.4:712
10388 msgid "I<mt_resid>"
10391 #. type: Plain text
10392 #: build/C/man4/st.4:714
10393 msgid "contains the current tape partition number."
10397 #: build/C/man4/st.4:714
10399 msgid "I<mt_dsreg>"
10402 #. type: Plain text
10403 #: build/C/man4/st.4:723
10405 "reports the drive's current settings for block size (in the low 24 bits) and "
10406 "density (in the high 8 bits). These fields are defined by "
10407 "B<MT_ST_BLKSIZE_SHIFT>, B<MT_ST_BLKSIZE_MASK>, B<MT_ST_DENSITY_SHIFT>, and "
10408 "B<MT_ST_DENSITY_MASK>."
10412 #: build/C/man4/st.4:723
10414 msgid "I<mt_gstat>"
10417 #. type: Plain text
10418 #: build/C/man4/st.4:726
10420 "reports generic (device independent) status information. The header file "
10421 "defines macros for testing these status bits:"
10424 #. type: Plain text
10425 #: build/C/man4/st.4:733
10427 "B<GMT_EOF>(I<x>): The tape is positioned just after a filemark (always false "
10428 "after an B<MTSEEK> operation)."
10431 #. type: Plain text
10432 #: build/C/man4/st.4:739
10434 "B<GMT_BOT>(I<x>): The tape is positioned at the beginning of the first file "
10435 "(always false after an B<MTSEEK> operation)."
10438 #. type: Plain text
10439 #: build/C/man4/st.4:742
10440 msgid "B<GMT_EOT>(I<x>): A tape operation has reached the physical End Of Tape."
10443 #. type: Plain text
10444 #: build/C/man4/st.4:748
10446 "B<GMT_SM>(I<x>): The tape is currently positioned at a setmark (always false "
10447 "after an B<MTSEEK> operation)."
10450 #. type: Plain text
10451 #: build/C/man4/st.4:751
10452 msgid "B<GMT_EOD>(I<x>): The tape is positioned at the end of recorded data."
10455 #. type: Plain text
10456 #: build/C/man4/st.4:756
10458 "B<GMT_WR_PROT>(I<x>): The drive is write-protected. For some drives this "
10459 "can also mean that the drive does not support writing on the current medium "
10463 #. type: Plain text
10464 #: build/C/man4/st.4:761
10466 "B<GMT_ONLINE>(I<x>): The last B<open>(2) found the drive with a tape in "
10467 "place and ready for operation."
10470 #. type: Plain text
10471 #: build/C/man4/st.4:765
10473 "B<GMT_D_6250>(I<x>), B<GMT_D_1600>(I<x>), B<GMT_D_800>(I<x>): This "
10474 "\\(lqgeneric\\(rq status information reports the current density setting for "
10475 "9-track \\(12\" tape drives only."
10478 #. type: Plain text
10479 #: build/C/man4/st.4:768
10480 msgid "B<GMT_DR_OPEN>(I<x>): The drive does not have a tape in place."
10483 #. type: Plain text
10484 #: build/C/man4/st.4:776
10486 "B<GMT_IM_REP_EN>(I<x>): Immediate report mode. This bit is set if there are "
10487 "no guarantees that the data has been physically written to the tape when the "
10488 "write call returns. It is set zero only when the driver does not buffer "
10489 "data and the drive is set not to buffer data."
10492 #. type: Plain text
10493 #: build/C/man4/st.4:780
10495 "B<GMT_CLN>(I<x>): The drive has requested cleaning. Implemented in kernels "
10496 "since 2.4.19 and 2.5.43."
10500 #: build/C/man4/st.4:781
10502 msgid "I<mt_erreg>"
10505 #. type: Plain text
10506 #: build/C/man4/st.4:791
10508 "The only field defined in I<mt_erreg> is the recovered error count in the "
10509 "low 16 bits (as defined by B<MT_ST_SOFTERR_SHIFT> and "
10510 "B<MT_ST_SOFTERR_MASK>. Due to inconsistencies in the way drives report "
10511 "recovered errors, this count is often not maintained (most drives do not by "
10512 "default report soft errors but this can be changed with a SCSI MODE SELECT "
10517 #: build/C/man4/st.4:791
10519 msgid "I<mt_fileno>"
10522 #. type: Plain text
10523 #: build/C/man4/st.4:797
10525 "reports the current file number (zero-based). This value is set to -1 when "
10526 "the file number is unknown (e.g., after B<MTBSS> or B<MTSEEK>)."
10530 #: build/C/man4/st.4:797
10532 msgid "I<mt_blkno>"
10535 #. type: Plain text
10536 #: build/C/man4/st.4:804
10538 "reports the block number (zero-based) within the current file. This value "
10539 "is set to -1 when the block number is unknown (e.g., after B<MTBSF>, "
10540 "B<MTBSS>, or B<MTSEEK>)."
10544 #: build/C/man4/st.4:804
10546 msgid "MTIOCPOS \\(em get tape position"
10549 #. type: Plain text
10550 #: build/C/man4/st.4:818
10552 "This request takes an argument of type I<(struct mtpos\\ *)> and reports the "
10553 "drive's notion of the current tape block number, which is not the same as "
10554 "I<mt_blkno> returned by B<MTIOCGET>. This drive must be a SCSI-2 drive that "
10555 "supports the B<READ POSITION> command (device-specific address) or a "
10556 "Tandberg-compatible SCSI-1 drive (Tandberg, Archive Viper, Wangtek, ... )."
10559 #. type: Plain text
10560 #: build/C/man4/st.4:825
10563 "/* structure for MTIOCPOS - mag tape get position command */\n"
10565 " long mt_blkno; /* current block number */\n"
10569 #. type: Plain text
10570 #: build/C/man4/st.4:834
10572 "An attempt was made to write or erase a write-protected tape. (This error "
10573 "is not detected during B<open>(2).)"
10577 #: build/C/man4/st.4:834
10582 #. type: Plain text
10583 #: build/C/man4/st.4:838
10584 msgid "The device is already in use or the driver was unable to allocate a buffer."
10587 #. type: Plain text
10588 #: build/C/man4/st.4:842
10589 msgid "The command parameters point to memory not belonging to the calling process."
10592 #. type: Plain text
10593 #: build/C/man4/st.4:847
10595 "An B<ioctl>(2) had an invalid argument, or a requested block size was "
10600 #: build/C/man4/st.4:847
10605 #. type: Plain text
10606 #: build/C/man4/st.4:850
10607 msgid "The requested operation could not be completed."
10610 #. type: Plain text
10611 #: build/C/man4/st.4:857
10613 "The byte count in B<read>(2) is smaller than the next physical block on the "
10614 "tape. (Before 2.2.18 and 2.4.0-test6 the extra bytes have been silently "
10618 #. type: Plain text
10619 #: build/C/man4/st.4:861
10621 "A write operation could not be completed because the tape reached "
10626 #: build/C/man4/st.4:861 build/C/man2/syslog.2:278
10631 #. type: Plain text
10632 #: build/C/man4/st.4:865
10633 msgid "Unknown B<ioctl>(2)."
10637 #: build/C/man4/st.4:865
10642 #. type: Plain text
10643 #: build/C/man4/st.4:868
10644 msgid "During opening, the tape device does not exist."
10648 #: build/C/man4/st.4:868
10650 msgid "B<EOVERFLOW>"
10653 #. type: Plain text
10654 #: build/C/man4/st.4:872
10656 "An attempt was made to read or write a variable-length block that is larger "
10657 "than the driver's internal buffer."
10660 #. type: Plain text
10661 #: build/C/man4/st.4:879
10663 "Open is attempted with B<O_WRONLY> or B<O_RDWR> when the tape in the drive "
10664 "is write-protected."
10668 #: build/C/man4/st.4:880
10670 msgid "I</dev/st*>"
10673 #. type: Plain text
10674 #: build/C/man4/st.4:883
10675 msgid "the auto-rewind SCSI tape devices"
10679 #: build/C/man4/st.4:883
10681 msgid "I</dev/nst*>"
10685 #. The driver has been written by Kai M\(:akisara (Kai.Makisara@metla.fi)
10686 #. starting from a driver written by Dwayne Forsyth.
10688 #. people have also contributed to the driver.
10689 #. type: Plain text
10690 #: build/C/man4/st.4:891
10691 msgid "the nonrewind SCSI tape devices"
10694 #. type: Plain text
10695 #: build/C/man4/st.4:912
10697 "When exchanging data between systems, both systems have to agree on the "
10698 "physical tape block size. The parameters of a drive after startup are often "
10699 "not the ones most operating systems use with these devices. Most systems "
10700 "use drives in variable-block mode if the drive supports that mode. This "
10701 "applies to most modern drives, including DATs, 8mm helical scan drives, "
10702 "DLTs, etc. It may be advisable to use these drives in variable-block mode "
10703 "also in Linux (i.e., use B<MTSETBLK> or B<MTSETDEFBLK> at system startup to "
10704 "set the mode), at least when exchanging data with a foreign system. The "
10705 "drawback of this is that a fairly large tape block size has to be used to "
10706 "get acceptable data transfer rates on the SCSI bus."
10709 #. type: Plain text
10710 #: build/C/man4/st.4:919
10712 "Many programs (e.g., B<tar>(1)) allow the user to specify the blocking "
10713 "factor on the command line. Note that this determines the physical block "
10714 "size on tape only in variable-block mode."
10717 #. type: Plain text
10718 #: build/C/man4/st.4:926
10720 "In order to use SCSI tape drives, the basic SCSI driver, a SCSI-adapter "
10721 "driver and the SCSI tape driver must be either configured into the kernel or "
10722 "loaded as modules. If the SCSI-tape driver is not present, the drive is "
10723 "recognized but the tape support described in this page is not available."
10726 #. type: Plain text
10727 #: build/C/man4/st.4:931
10729 "The driver writes error messages to the console/log. The SENSE codes "
10730 "written into some messages are automatically translated to text if verbose "
10731 "SCSI messages are enabled in kernel configuration."
10735 #. Copyright \(co 1995 Robert K. Nichols.
10737 #. Copyright \(co 1999-2005 Kai M\(:akisara.
10739 #. %%%LICENSE_START(VERBATIM)
10740 #. Permission is granted to make and distribute verbatim copies of this
10741 #. manual provided the copyright notice and this permission notice are
10742 #. preserved on all copies.
10743 #. Additional permissions are contained in the header of the source file.
10744 #. type: Plain text
10745 #: build/C/man4/st.4:954
10747 "The driver's internal buffering allows good throughput in fixed-block mode "
10748 "also with small B<read>(2) and B<write>(2) byte counts. With direct "
10749 "transfers this is not possible and may cause a surprise when moving to the "
10750 "2.6 kernel. The solution is to tell the software to use larger transfers "
10751 "(often telling it to use larger blocks). If this is not possible, direct "
10752 "transfers can be disabled."
10755 #. type: Plain text
10756 #: build/C/man4/st.4:956
10760 #. type: Plain text
10761 #: build/C/man4/st.4:964
10763 "The file I<drivers/scsi/README.st> or I<Documentation/scsi/st.txt> (kernel "
10764 "E<gt>= 2.6) in the Linux kernel source tree contains the most recent "
10765 "information about the driver and its configuration possibilities"
10769 #: build/C/man3/stdarg.3:43
10774 #. type: Plain text
10775 #: build/C/man3/stdarg.3:46
10776 msgid "stdarg, va_start, va_arg, va_end, va_copy - variable argument lists"
10779 #. type: Plain text
10780 #: build/C/man3/stdarg.3:48 build/C/man3/syslog.3:49
10781 msgid "B<#include E<lt>stdarg.hE<gt>>"
10784 #. type: Plain text
10785 #: build/C/man3/stdarg.3:50
10786 msgid "B<void va_start(va_list >I<ap>B<, >I<last>B<);>"
10789 #. type: Plain text
10790 #: build/C/man3/stdarg.3:52
10791 msgid "I<type>B< va_arg(va_list >I<ap>B<, >I<type>B<);>"
10794 #. type: Plain text
10795 #: build/C/man3/stdarg.3:54
10796 msgid "B<void va_end(va_list >I<ap>B<);>"
10799 #. type: Plain text
10800 #: build/C/man3/stdarg.3:56
10801 msgid "B<void va_copy(va_list >I<dest>B<, va_list >I<src>B<);>"
10804 #. type: Plain text
10805 #: build/C/man3/stdarg.3:65
10807 "A function may be called with a varying number of arguments of varying "
10808 "types. The include file I<E<lt>stdarg.hE<gt>> declares a type I<va_list> "
10809 "and defines three macros for stepping through a list of arguments whose "
10810 "number and types are not known to the called function."
10813 #. type: Plain text
10814 #: build/C/man3/stdarg.3:73
10816 "The called function must declare an object of type I<va_list> which is used "
10817 "by the macros B<va_start>(), B<va_arg>(), and B<va_end>()."
10821 #: build/C/man3/stdarg.3:73
10826 #. type: Plain text
10827 #: build/C/man3/stdarg.3:83
10829 "The B<va_start>() macro initializes I<ap> for subsequent use by B<va_arg>() "
10830 "and B<va_end>(), and must be called first."
10833 #. type: Plain text
10834 #: build/C/man3/stdarg.3:88
10836 "The argument I<last> is the name of the last argument before the variable "
10837 "argument list, that is, the last argument of which the calling function "
10841 #. type: Plain text
10842 #: build/C/man3/stdarg.3:93
10844 "Because the address of this argument may be used in the B<va_start>() "
10845 "macro, it should not be declared as a register variable, or as a function or "
10850 #: build/C/man3/stdarg.3:93
10855 #. type: Plain text
10856 #: build/C/man3/stdarg.3:115
10858 "The B<va_arg>() macro expands to an expression that has the type and value "
10859 "of the next argument in the call. The argument I<ap> is the I<va_list> "
10860 "I<ap> initialized by B<va_start>(). Each call to B<va_arg>() modifies "
10861 "I<ap> so that the next call returns the next argument. The argument I<type> "
10862 "is a type name specified so that the type of a pointer to an object that has "
10863 "the specified type can be obtained simply by adding a * to I<type>."
10866 #. type: Plain text
10867 #: build/C/man3/stdarg.3:123
10869 "The first use of the B<va_arg>() macro after that of the B<va_start>() "
10870 "macro returns the argument after I<last>. Successive invocations return the "
10871 "values of the remaining arguments."
10874 #. type: Plain text
10875 #: build/C/man3/stdarg.3:128
10877 "If there is no next argument, or if I<type> is not compatible with the type "
10878 "of the actual next argument (as promoted according to the default argument "
10879 "promotions), random errors will occur."
10882 #. type: Plain text
10883 #: build/C/man3/stdarg.3:136
10885 "If I<ap> is passed to a function that uses B<va_arg(>I<ap>B<,>I<type>B<)> "
10886 "then the value of I<ap> is undefined after the return of that function."
10890 #: build/C/man3/stdarg.3:136
10895 #. type: Plain text
10896 #: build/C/man3/stdarg.3:155
10898 "Each invocation of B<va_start>() must be matched by a corresponding "
10899 "invocation of B<va_end>() in the same function. After the call "
10900 "B<va_end(>I<ap>B<)> the variable I<ap> is undefined. Multiple traversals of "
10901 "the list, each bracketed by B<va_start>() and B<va_end>() are possible. "
10902 "B<va_end>() may be a macro or a function."
10906 #: build/C/man3/stdarg.3:155
10911 #. type: Plain text
10912 #: build/C/man3/stdarg.3:172
10914 "The B<va_copy>() macro copies the (previously initialized) variable "
10915 "argument list I<src> to I<dest>. The behavior is as if B<va_start>() were "
10916 "applied to I<dest> with the same I<last> argument, followed by the same "
10917 "number of B<va_arg>() invocations that was used to reach the current state "
10921 #. Proposal from clive@demon.net, 1997-02-28
10922 #. type: Plain text
10923 #: build/C/man3/stdarg.3:179
10925 "An obvious implementation would have a I<va_list> be a pointer to the stack "
10926 "frame of the variadic function. In such a setup (by far the most common) "
10927 "there seems nothing against an assignment"
10930 #. type: Plain text
10931 #: build/C/man3/stdarg.3:183
10933 msgid "va_list aq = ap;\n"
10936 #. type: Plain text
10937 #: build/C/man3/stdarg.3:188
10939 "Unfortunately, there are also systems that make it an array of pointers (of "
10940 "length 1), and there one needs"
10943 #. type: Plain text
10944 #: build/C/man3/stdarg.3:193
10951 #. type: Plain text
10952 #: build/C/man3/stdarg.3:209
10954 "Finally, on systems where arguments are passed in registers, it may be "
10955 "necessary for B<va_start>() to allocate memory, store the arguments there, "
10956 "and also an indication of which argument is next, so that B<va_arg>() can "
10957 "step through the list. Now B<va_end>() can free the allocated memory "
10958 "again. To accommodate this situation, C99 adds a macro B<va_copy>(), so "
10959 "that the above assignment can be replaced by"
10962 #. type: Plain text
10963 #: build/C/man3/stdarg.3:216
10967 "va_copy(aq, ap);\n"
10972 #. type: Plain text
10973 #: build/C/man3/stdarg.3:229
10975 "Each invocation of B<va_copy>() must be matched by a corresponding "
10976 "invocation of B<va_end>() in the same function. Some systems that do not "
10977 "supply B<va_copy>() have B<__va_copy> instead, since that was the name used "
10978 "in the draft proposal."
10981 #. type: Plain text
10982 #: build/C/man3/stdarg.3:239
10984 "The B<va_start>(), B<va_arg>(), and B<va_end>() macros conform to C89. C99 "
10985 "defines the B<va_copy>() macro."
10988 #. type: Plain text
10989 #: build/C/man3/stdarg.3:245
10991 "These macros are I<not> compatible with the historic macros they replace. A "
10992 "backward-compatible version can be found in the include file "
10993 "I<E<lt>varargs.hE<gt>>."
10996 #. type: Plain text
10997 #: build/C/man3/stdarg.3:247
10998 msgid "The historic setup is:"
11001 #. type: Plain text
11002 #: build/C/man3/stdarg.3:251
11004 msgid "#include E<lt>varargs.hE<gt>\n"
11007 #. type: Plain text
11008 #: build/C/man3/stdarg.3:257
11018 #. type: Plain text
11019 #: build/C/man3/stdarg.3:266
11025 " x = va_arg(ap, type);\n"
11032 #. type: Plain text
11033 #: build/C/man3/stdarg.3:275
11035 "On some systems, I<va_end> contains a closing \\(aq}\\(aq matching a "
11036 "\\(aq{\\(aq in I<va_start>, so that both macros must occur in the same "
11037 "function, and in a way that allows this."
11040 #. type: Plain text
11041 #: build/C/man3/stdarg.3:291
11043 "Unlike the B<varargs> macros, the B<stdarg> macros do not permit programmers "
11044 "to code a function with no fixed arguments. This problem generates work "
11045 "mainly when converting B<varargs> code to B<stdarg> code, but it also "
11046 "creates difficulties for variadic functions that wish to pass all of their "
11047 "arguments on to a function that takes a I<va_list> argument, such as "
11051 #. type: Plain text
11052 #: build/C/man3/stdarg.3:296
11054 "The function I<foo> takes a string of format characters and prints out the "
11055 "argument associated with each format character based on the type."
11058 #. type: Plain text
11059 #: build/C/man3/stdarg.3:300
11062 "#include E<lt>stdio.hE<gt>\n"
11063 "#include E<lt>stdarg.hE<gt>\n"
11066 #. type: Plain text
11067 #: build/C/man3/stdarg.3:307
11071 "foo(char *fmt, ...)\n"
11078 #. type: Plain text
11079 #: build/C/man3/stdarg.3:328
11082 " va_start(ap, fmt);\n"
11084 " switch (*fmt++) {\n"
11085 " case \\(aqs\\(aq: /* string */\n"
11086 " s = va_arg(ap, char *);\n"
11087 " printf(\"string %s\\en\", s);\n"
11089 " case \\(aqd\\(aq: /* int */\n"
11090 " d = va_arg(ap, int);\n"
11091 " printf(\"int %d\\en\", d);\n"
11093 " case \\(aqc\\(aq: /* char */\n"
11094 " /* need a cast here since va_arg only\n"
11095 " takes fully promoted types */\n"
11096 " c = (char) va_arg(ap, int);\n"
11097 " printf(\"char %c\\en\", c);\n"
11105 #: build/C/man2/syslog.2:31 build/C/man3/syslog.3:36
11111 #: build/C/man2/syslog.2:31
11116 #. type: Plain text
11117 #: build/C/man2/syslog.2:35
11119 "syslog, klogctl - read and/or clear kernel message ring buffer; set "
11123 #. type: Plain text
11124 #: build/C/man2/syslog.2:39
11127 "B<int syslog(int >I<type>B<, char *>I<bufp>B<, int >I<len>B<);>\n"
11128 "B</* No wrapper provided in glibc */>\n"
11131 #. type: Plain text
11132 #: build/C/man2/syslog.2:41
11134 msgid "/* The glibc interface */\n"
11137 #. type: Plain text
11138 #: build/C/man2/syslog.2:43
11140 msgid "B<#include E<lt>sys/klog.hE<gt>>\n"
11143 #. type: Plain text
11144 #: build/C/man2/syslog.2:45
11146 msgid "B<int klogctl(int >I<type>B<, char *>I<bufp>B<, int >I<len>B<);>\n"
11149 #. type: Plain text
11150 #: build/C/man2/syslog.2:57
11152 "If you need the C library function B<syslog>() (which talks to "
11153 "B<syslogd>(8)), then look at B<syslog>(3). The system call of this name is "
11154 "about controlling the kernel I<printk>() buffer, and the glibc wrapper "
11155 "function is called B<klogctl>()."
11159 #: build/C/man2/syslog.2:57
11161 msgid "The kernel log buffer"
11164 #. Under "General setup" ==> "Kernel log buffer size"
11165 #. For 2.6, precisely the option seems to have appeared in 2.5.55.
11166 #. type: Plain text
11167 #: build/C/man2/syslog.2:73
11169 "The kernel has a cyclic buffer of length B<LOG_BUF_LEN> in which messages "
11170 "given as arguments to the kernel function B<printk>() are stored "
11171 "(regardless of their loglevel). In early kernels, B<LOG_BUF_LEN> had the "
11172 "value 4096; from kernel 1.3.54, it was 8192; from kernel 2.1.113 it was "
11173 "16384; since 2.4.23/2.6 the value is a kernel configuration option "
11174 "(B<CONFIG_LOG_BUF_SHIFT>). In recent kernels the size can be queried with "
11175 "command type 10 (see below)."
11179 #: build/C/man2/syslog.2:73
11184 #. type: Plain text
11185 #: build/C/man2/syslog.2:80
11187 "The I<type> argument determines the action taken by this function. The list "
11188 "below specifies the values for I<type>. The symbolic names are defined in "
11189 "the kernel source, but are not exported to user space; you will either need "
11190 "to use the numbers, or define the names yourself."
11194 #: build/C/man2/syslog.2:80
11196 msgid "B<SYSLOG_ACTION_CLOSE> (0)"
11199 #. type: Plain text
11200 #: build/C/man2/syslog.2:84
11201 msgid "Close the log. Currently a NOP."
11205 #: build/C/man2/syslog.2:84
11207 msgid "B<SYSLOG_ACTION_OPEN> (1)"
11210 #. type: Plain text
11211 #: build/C/man2/syslog.2:88
11212 msgid "Open the log. Currently a NOP."
11216 #: build/C/man2/syslog.2:88
11218 msgid "B<SYSLOG_ACTION_READ> (2)"
11221 #. type: Plain text
11222 #: build/C/man2/syslog.2:100
11224 "Read from the log. The call waits until the kernel log buffer is nonempty, "
11225 "and then reads at most I<len> bytes into the buffer pointed to by I<bufp>. "
11226 "The call returns the number of bytes read. Bytes read from the log "
11227 "disappear from the log buffer: the information can be read only once. This "
11228 "is the function executed by the kernel when a user program reads "
11233 #: build/C/man2/syslog.2:100
11235 msgid "B<SYSLOG_ACTION_READ_ALL> (3)"
11238 #. type: Plain text
11239 #: build/C/man2/syslog.2:110
11241 "Read all messages remaining in the ring buffer, placing then in the buffer "
11242 "pointed to by I<bufp>. The call reads the last I<len> bytes from the log "
11243 "buffer (nondestructively), but will not read more than was written into the "
11244 "buffer since the last \"clear ring buffer\" command (see command 5 below)). "
11245 "The call returns the number of bytes read."
11249 #: build/C/man2/syslog.2:110
11251 msgid "B<SYSLOG_ACTION_READ_CLEAR> (4)"
11254 #. type: Plain text
11255 #: build/C/man2/syslog.2:116
11257 "Read and clear all messages remaining in the ring buffer. The call does "
11258 "precisely the same as for a I<type> of 3, but also executes the \"clear ring "
11259 "buffer\" command."
11263 #: build/C/man2/syslog.2:116
11265 msgid "B<SYSLOG_ACTION_CLEAR> (5)"
11268 #. type: Plain text
11269 #: build/C/man2/syslog.2:124
11271 "The call executes just the \"clear ring buffer\" command. The I<bufp> and "
11272 "I<len> arguments are ignored."
11275 #. type: Plain text
11276 #: build/C/man2/syslog.2:135
11278 "This command does not really clear the ring buffer. Rather, it sets a "
11279 "kernel bookkeeping variable that determines the results returned by commands "
11280 "3 (B<SYSLOG_ACTION_READ_ALL>) and 4 (B<SYSLOG_ACTION_READ_CLEAR>). This "
11281 "command has no effect on commands 2 (B<SYSLOG_ACTION_READ>) and 9 "
11282 "(B<SYSLOG_ACTION_SIZE_UNREAD>)."
11286 #: build/C/man2/syslog.2:135
11288 msgid "B<SYSLOG_ACTION_CONSOLE_OFF> (6)"
11291 #. type: Plain text
11292 #: build/C/man2/syslog.2:145
11294 "Disable printk to console. The call sets the console log level to the "
11295 "minimum, so that no messages are printed to the console. The I<bufp> and "
11296 "I<len> arguments are ignored."
11300 #: build/C/man2/syslog.2:145
11302 msgid "B<SYSLOG_ACTION_CONSOLE_ON> (7)"
11305 #. type: Plain text
11306 #: build/C/man2/syslog.2:154
11308 "The call sets the console log level to the default, so that messages are "
11309 "printed to the console. The I<bufp> and I<len> arguments are ignored."
11313 #: build/C/man2/syslog.2:154
11315 msgid "B<SYSLOG_ACTION_CONSOLE_LEVEL> (8)"
11318 #. type: Plain text
11319 #: build/C/man2/syslog.2:165
11321 "The call sets the console log level to the value given in I<len>, which must "
11322 "be an integer between 1 and 8 (inclusive). See the B<loglevel> section for "
11323 "details. The I<bufp> argument is ignored."
11327 #: build/C/man2/syslog.2:165
11329 msgid "B<SYSLOG_ACTION_SIZE_UNREAD> (9) (since Linux 2.4.10)"
11332 #. type: Plain text
11333 #: build/C/man2/syslog.2:176
11335 "The call returns the number of bytes currently available to be read from the "
11336 "kernel log buffer via command 2 (B<SYSLOG_ACTION_READ>). The I<bufp> and "
11337 "I<len> arguments are ignored."
11341 #: build/C/man2/syslog.2:176
11343 msgid "B<SYSLOG_ACTION_SIZE_BUFFER> (10) (since Linux 2.6.6)"
11346 #. type: Plain text
11347 #: build/C/man2/syslog.2:184
11349 "This command returns the total size of the kernel log buffer. The I<bufp> "
11350 "and I<len> arguments are ignored."
11353 #. type: Plain text
11354 #: build/C/man2/syslog.2:201
11356 "All commands except 3 and 10 require privilege. In Linux kernels before "
11357 "2.6.37, command types 3 and 10 are allowed to unprivileged processes; since "
11358 "Linux 2.6.37, these commands are allowed to unprivileged processes only if "
11359 "I</proc/sys/kernel/dmesg_restrict> has the value 0. Before Linux 2.6.37, "
11360 "\"privileged\" means that the caller has the B<CAP_SYS_ADMIN> capability. "
11361 "Since Linux 2.6.37, \"privileged\" means that the caller has either the "
11362 "B<CAP_SYS_ADMIN> capability (now deprecated for this purpose) or the (new) "
11363 "B<CAP_SYSLOG> capability."
11367 #: build/C/man2/syslog.2:201
11369 msgid "The loglevel"
11372 #. type: Plain text
11373 #: build/C/man2/syslog.2:223
11375 "The kernel routine B<printk>() will only print a message on the console, if "
11376 "it has a loglevel less than the value of the variable I<console_loglevel>. "
11377 "This variable initially has the value B<DEFAULT_CONSOLE_LOGLEVEL> (7), but "
11378 "is set to 10 if the kernel command line contains the word \"debug\", and to "
11379 "15 in case of a kernel fault (the 10 and 15 are just silly, and equivalent "
11380 "to 8). This variable is set (to a value in the range 1-8) by a B<syslog>() "
11381 "call with a I<type> of 8. Calls to B<syslog>() with I<type> equal to 6 or "
11382 "7 set the variable to 1 (kernel panics only) or 7 (all except debugging "
11383 "messages), respectively."
11386 #. type: Plain text
11387 #: build/C/man2/syslog.2:233
11389 "Every text line in a message has its own loglevel. This level is "
11390 "I<DEFAULT_MESSAGE_LOGLEVEL - 1> (6) unless the line starts with E<lt>dE<gt> "
11391 "where I<d> is a digit in the range 1-7, in which case the level is I<d>. "
11392 "The conventional meaning of the loglevel is defined in "
11393 "I<E<lt>linux/kernel.hE<gt>> as follows:"
11396 #. type: Plain text
11397 #: build/C/man2/syslog.2:243
11400 "#define KERN_EMERG \"E<lt>0E<gt>\" /* system is unusable "
11402 "#define KERN_ALERT \"E<lt>1E<gt>\" /* action must be taken immediately "
11404 "#define KERN_CRIT \"E<lt>2E<gt>\" /* critical conditions "
11406 "#define KERN_ERR \"E<lt>3E<gt>\" /* error conditions "
11408 "#define KERN_WARNING \"E<lt>4E<gt>\" /* warning conditions "
11410 "#define KERN_NOTICE \"E<lt>5E<gt>\" /* normal but significant condition "
11412 "#define KERN_INFO \"E<lt>6E<gt>\" /* informational "
11414 "#define KERN_DEBUG \"E<lt>7E<gt>\" /* debug-level messages "
11418 #. type: Plain text
11419 #: build/C/man2/syslog.2:257
11421 "For I<type> equal to 2, 3, or 4, a successful call to B<syslog>() returns "
11422 "the number of bytes read. For I<type> 9, B<syslog>() returns the number of "
11423 "bytes currently available to be read on the kernel log buffer. For I<type> "
11424 "10, B<syslog>() returns the total size of the kernel log buffer. For other "
11425 "values of I<type>, 0 is returned on success."
11428 #. type: Plain text
11429 #: build/C/man2/syslog.2:260
11430 msgid "In case of error, -1 is returned, and I<errno> is set to indicate the error."
11433 #. type: Plain text
11434 #: build/C/man2/syslog.2:278
11436 "Bad arguments (e.g., bad I<type>; or for I<type> 2, 3, or 4, I<buf> is NULL, "
11437 "or I<len> is less than zero; or for I<type> 8, the I<level> is outside the "
11441 #. type: Plain text
11442 #: build/C/man2/syslog.2:285
11444 "This B<syslog>() system call is not available, because the kernel was "
11445 "compiled with the B<CONFIG_PRINTK> kernel-configuration option disabled."
11448 #. type: Plain text
11449 #: build/C/man2/syslog.2:294
11451 "An attempt was made to change console_loglevel or clear the kernel message "
11452 "ring buffer by a process without sufficient privilege (more precisely: "
11453 "without the B<CAP_SYS_ADMIN> or B<CAP_SYSLOG> capability)."
11457 #: build/C/man2/syslog.2:294
11459 msgid "B<ERESTARTSYS>"
11462 #. type: Plain text
11463 #: build/C/man2/syslog.2:298
11465 "System call was interrupted by a signal; nothing was read. (This can be "
11466 "seen only during a trace.)"
11469 #. type: Plain text
11470 #: build/C/man2/syslog.2:301
11472 "This system call is Linux-specific and should not be used in programs "
11473 "intended to be portable."
11476 #. In libc4 and libc5 the number of this call was defined by
11478 #. In glibc 2.0 the syscall is baptized
11480 #. type: Plain text
11481 #: build/C/man2/syslog.2:309
11483 "From the very start people noted that it is unfortunate that a system call "
11484 "and a library routine of the same name are entirely different animals."
11487 #. type: Plain text
11488 #: build/C/man2/syslog.2:312
11489 msgid "B<syslog>(3), B<capabilities>(7)"
11493 #: build/C/man3/syslog.3:36
11498 #. type: Plain text
11499 #: build/C/man3/syslog.3:39
11500 msgid "closelog, openlog, syslog, vsyslog - send messages to the system logger"
11503 #. type: Plain text
11504 #: build/C/man3/syslog.3:41
11505 msgid "B<#include E<lt>syslog.hE<gt>>"
11508 #. type: Plain text
11509 #: build/C/man3/syslog.3:43
11511 "B<void openlog(const char *>I<ident>B<, int >I<option>B<, int "
11512 ">I<facility>B<);>"
11515 #. type: Plain text
11516 #: build/C/man3/syslog.3:45
11517 msgid "B<void syslog(int >I<priority>B<, const char *>I<format>B<, ...);>"
11520 #. type: Plain text
11521 #: build/C/man3/syslog.3:47
11522 msgid "B<void closelog(void);>"
11525 #. type: Plain text
11526 #: build/C/man3/syslog.3:51
11528 "B<void vsyslog(int >I<priority>B<, const char *>I<format>B<, va_list "
11532 #. type: Plain text
11533 #: build/C/man3/syslog.3:59
11534 msgid "B<vsyslog>(): _BSD_SOURCE"
11537 #. type: Plain text
11538 #: build/C/man3/syslog.3:65
11540 "B<closelog>() closes the descriptor being used to write to the system "
11541 "logger. The use of B<closelog>() is optional."
11544 #. type: Plain text
11545 #: build/C/man3/syslog.3:77
11547 "B<openlog>() opens a connection to the system logger for a program. The "
11548 "string pointed to by I<ident> is prepended to every message, and is "
11549 "typically set to the program name. If I<ident> is NULL, the program name is "
11550 "used. (POSIX.1-2008 does not specify the behavior when I<ident> is NULL.)"
11553 #. type: Plain text
11554 #: build/C/man3/syslog.3:101
11556 "The I<option> argument specifies flags which control the operation of "
11557 "B<openlog>() and subsequent calls to B<syslog>(). The I<facility> argument "
11558 "establishes a default to be used if none is specified in subsequent calls to "
11559 "B<syslog>(). Values for I<option> and I<facility> are given below. The use "
11560 "of B<openlog>() is optional; it will automatically be called by B<syslog>() "
11561 "if necessary, in which case I<ident> will default to NULL."
11564 #. type: Plain text
11565 #: build/C/man3/syslog.3:125
11567 "B<syslog>() generates a log message, which will be distributed by "
11568 "B<syslogd>(8). The I<priority> argument is formed by ORing the I<facility> "
11569 "and the I<level> values (explained below). The remaining arguments are a "
11570 "I<format>, as in B<printf>(3) and any arguments required by the I<format>, "
11571 "except that the two character sequence B<%m> will be replaced by the error "
11572 "message string I<strerror>(I<errno>). A trailing newline may be added if "
11576 #. type: Plain text
11577 #: build/C/man3/syslog.3:134
11579 "The function B<vsyslog>() performs the same task as B<syslog>() with the "
11580 "difference that it takes a set of arguments which have been obtained using "
11581 "the B<stdarg>(3) variable argument list macros."
11584 #. type: Plain text
11585 #: build/C/man3/syslog.3:137
11587 "The subsections below list the parameters used to set the values of "
11588 "I<option>,I< facility>, and I<priority>."
11592 #: build/C/man3/syslog.3:137
11597 #. type: Plain text
11598 #: build/C/man3/syslog.3:143
11599 msgid "The I<option> argument to B<openlog>() is an OR of any of these:"
11603 #: build/C/man3/syslog.3:143
11605 msgid "B<LOG_CONS>"
11608 #. type: Plain text
11609 #: build/C/man3/syslog.3:147
11611 "Write directly to system console if there is an error while sending to "
11616 #: build/C/man3/syslog.3:147
11618 msgid "B<LOG_NDELAY>"
11621 #. type: Plain text
11622 #: build/C/man3/syslog.3:151
11624 "Open the connection immediately (normally, the connection is opened when the "
11625 "first message is logged)."
11629 #: build/C/man3/syslog.3:151
11631 msgid "B<LOG_NOWAIT>"
11634 #. type: Plain text
11635 #: build/C/man3/syslog.3:157
11637 "Don't wait for child processes that may have been created while logging the "
11638 "message. (The GNU C library does not create a child process, so this option "
11639 "has no effect on Linux.)"
11643 #: build/C/man3/syslog.3:157
11645 msgid "B<LOG_ODELAY>"
11648 #. type: Plain text
11649 #: build/C/man3/syslog.3:165
11651 "The converse of B<LOG_NDELAY>; opening of the connection is delayed until "
11652 "B<syslog>() is called. (This is the default, and need not be specified.)"
11656 #: build/C/man3/syslog.3:165
11658 msgid "B<LOG_PERROR>"
11661 #. type: Plain text
11662 #: build/C/man3/syslog.3:169
11663 msgid "(Not in POSIX.1-2001 or POSIX.1-2008.) Print to I<stderr> as well."
11667 #: build/C/man3/syslog.3:169
11672 #. type: Plain text
11673 #: build/C/man3/syslog.3:172
11674 msgid "Include PID with each message."
11678 #: build/C/man3/syslog.3:172
11683 #. type: Plain text
11684 #: build/C/man3/syslog.3:178
11686 "The I<facility> argument is used to specify what type of program is logging "
11687 "the message. This lets the configuration file specify that messages from "
11688 "different facilities will be handled differently."
11692 #: build/C/man3/syslog.3:178
11694 msgid "B<LOG_AUTH>"
11697 #. type: Plain text
11698 #: build/C/man3/syslog.3:181
11699 msgid "security/authorization messages"
11703 #: build/C/man3/syslog.3:181
11705 msgid "B<LOG_AUTHPRIV>"
11708 #. type: Plain text
11709 #: build/C/man3/syslog.3:184
11710 msgid "security/authorization messages (private)"
11714 #: build/C/man3/syslog.3:184
11716 msgid "B<LOG_CRON>"
11719 #. type: Plain text
11720 #: build/C/man3/syslog.3:188
11721 msgid "clock daemon (B<cron> and B<at>)"
11725 #: build/C/man3/syslog.3:188
11727 msgid "B<LOG_DAEMON>"
11730 #. type: Plain text
11731 #: build/C/man3/syslog.3:191
11732 msgid "system daemons without separate facility value"
11736 #: build/C/man3/syslog.3:191
11741 #. type: Plain text
11742 #: build/C/man3/syslog.3:194
11747 #: build/C/man3/syslog.3:194
11749 msgid "B<LOG_KERN>"
11752 #. LOG_KERN has the value 0; if used as a facility, zero translates to:
11753 #. "use the default facility".
11754 #. type: Plain text
11755 #: build/C/man3/syslog.3:199
11756 msgid "kernel messages (these can't be generated from user processes)"
11760 #: build/C/man3/syslog.3:199
11762 msgid "B<LOG_LOCAL0> through B<LOG_LOCAL7>"
11765 #. type: Plain text
11766 #: build/C/man3/syslog.3:202
11767 msgid "reserved for local use"
11771 #: build/C/man3/syslog.3:202
11776 #. type: Plain text
11777 #: build/C/man3/syslog.3:205
11778 msgid "line printer subsystem"
11782 #: build/C/man3/syslog.3:205
11784 msgid "B<LOG_MAIL>"
11787 #. type: Plain text
11788 #: build/C/man3/syslog.3:208
11789 msgid "mail subsystem"
11793 #: build/C/man3/syslog.3:208
11795 msgid "B<LOG_NEWS>"
11798 #. type: Plain text
11799 #: build/C/man3/syslog.3:211
11800 msgid "USENET news subsystem"
11804 #: build/C/man3/syslog.3:211
11806 msgid "B<LOG_SYSLOG>"
11809 #. type: Plain text
11810 #: build/C/man3/syslog.3:215
11811 msgid "messages generated internally by B<syslogd>(8)"
11815 #: build/C/man3/syslog.3:215
11817 msgid "B<LOG_USER> (default)"
11820 #. type: Plain text
11821 #: build/C/man3/syslog.3:218
11822 msgid "generic user-level messages"
11826 #: build/C/man3/syslog.3:218
11828 msgid "B<LOG_UUCP>"
11831 #. type: Plain text
11832 #: build/C/man3/syslog.3:221
11833 msgid "UUCP subsystem"
11837 #: build/C/man3/syslog.3:221
11842 #. type: Plain text
11843 #: build/C/man3/syslog.3:224
11845 "This determines the importance of the message. The levels are, in order of "
11846 "decreasing importance:"
11850 #: build/C/man3/syslog.3:224
11852 msgid "B<LOG_EMERG>"
11855 #. type: Plain text
11856 #: build/C/man3/syslog.3:227
11857 msgid "system is unusable"
11861 #: build/C/man3/syslog.3:227
11863 msgid "B<LOG_ALERT>"
11866 #. type: Plain text
11867 #: build/C/man3/syslog.3:230
11868 msgid "action must be taken immediately"
11872 #: build/C/man3/syslog.3:230
11874 msgid "B<LOG_CRIT>"
11877 #. type: Plain text
11878 #: build/C/man3/syslog.3:233
11879 msgid "critical conditions"
11883 #: build/C/man3/syslog.3:233
11888 #. type: Plain text
11889 #: build/C/man3/syslog.3:236
11890 msgid "error conditions"
11894 #: build/C/man3/syslog.3:236
11896 msgid "B<LOG_WARNING>"
11899 #. type: Plain text
11900 #: build/C/man3/syslog.3:239
11901 msgid "warning conditions"
11905 #: build/C/man3/syslog.3:239
11907 msgid "B<LOG_NOTICE>"
11910 #. type: Plain text
11911 #: build/C/man3/syslog.3:242
11912 msgid "normal, but significant, condition"
11916 #: build/C/man3/syslog.3:242
11918 msgid "B<LOG_INFO>"
11921 #. type: Plain text
11922 #: build/C/man3/syslog.3:245
11923 msgid "informational message"
11927 #: build/C/man3/syslog.3:245
11929 msgid "B<LOG_DEBUG>"
11932 #. type: Plain text
11933 #: build/C/man3/syslog.3:248
11934 msgid "debug-level message"
11937 #. type: Plain text
11938 #: build/C/man3/syslog.3:252
11940 "The function B<setlogmask>(3) can be used to restrict logging to specified "
11947 #. function call appeared in 4.2BSD.
11948 #. 4.3BSD documents
11951 #. .BR closelog (),
11953 #. .BR setlogmask ().
11954 #. 4.3BSD-Reno also documents
11956 #. Of course early v* functions used the
11958 #. mechanism, which is not compatible with
11959 #. .IR <stdarg.h> .
11960 #. type: Plain text
11961 #: build/C/man3/syslog.3:296
11963 "The functions B<openlog>(), B<closelog>(), and B<syslog>() (but not "
11964 "B<vsyslog>()) are specified in SUSv2, POSIX.1-2001, and POSIX.1-2008. "
11965 "POSIX.1-2001 specifies only the B<LOG_USER> and B<LOG_LOCAL*> values for "
11966 "I<facility>. However, with the exception of B<LOG_AUTHPRIV> and B<LOG_FTP>, "
11967 "the other I<facility> values appear on most UNIX systems. The B<LOG_PERROR> "
11968 "value for I<option> is not specified by POSIX.1-2001 or POSIX.1-2008, but is "
11969 "available in most versions of UNIX."
11972 #. type: Plain text
11973 #: build/C/man3/syslog.3:308
11975 "The argument I<ident> in the call of B<openlog>() is probably stored "
11976 "as-is. Thus, if the string it points to is changed, B<syslog>() may start "
11977 "prepending the changed string, and if the string it points to ceases to "
11978 "exist, the results are undefined. Most portable is to use a string "
11982 #. type: Plain text
11983 #: build/C/man3/syslog.3:311
11985 "Never pass a string with user-supplied data as a format, use the following "
11989 #. type: Plain text
11990 #: build/C/man3/syslog.3:314
11992 msgid " syslog(priority, \"%s\", string);\n"
11995 #. type: Plain text
11996 #: build/C/man3/syslog.3:320
11997 msgid "B<logger>(1), B<setlogmask>(3), B<syslog.conf>(5), B<syslogd>(8)"
12001 #: build/C/man4/ttyS.4:26
12007 #: build/C/man4/ttyS.4:26
12012 #. type: Plain text
12013 #: build/C/man4/ttyS.4:29
12014 msgid "ttyS - serial terminal lines"
12017 #. type: Plain text
12018 #: build/C/man4/ttyS.4:32
12019 msgid "B<ttyS[0-3]> are character devices for the serial terminal lines."
12022 #. type: Plain text
12023 #: build/C/man4/ttyS.4:37
12024 msgid "mknod -m 660 /dev/ttyS0 c 4 64 # base address 0x3f8"
12027 #. type: Plain text
12028 #: build/C/man4/ttyS.4:39
12029 msgid "mknod -m 660 /dev/ttyS1 c 4 65 # base address 0x2f8"
12032 #. type: Plain text
12033 #: build/C/man4/ttyS.4:41
12034 msgid "mknod -m 660 /dev/ttyS2 c 4 66 # base address 0x3e8"
12037 #. type: Plain text
12038 #: build/C/man4/ttyS.4:43
12039 msgid "mknod -m 660 /dev/ttyS3 c 4 67 # base address 0x2e8"
12042 #. type: Plain text
12043 #: build/C/man4/ttyS.4:45
12044 msgid "chown root:tty /dev/ttyS[0-3]"
12047 #. type: Plain text
12048 #: build/C/man4/ttyS.4:48
12049 msgid "/dev/ttyS[0-3]"
12052 #. type: Plain text
12053 #: build/C/man4/ttyS.4:55
12055 "B<chown>(1), B<mknod>(1), B<tty>(4), B<agetty>(8), B<mingetty>(8), "
12060 #: build/C/man7/uri.7:48
12066 #: build/C/man7/uri.7:48
12071 #. type: Plain text
12072 #: build/C/man7/uri.7:51
12073 msgid "uri, url, urn - uniform resource identifier (URI), including a URL or URN"
12076 #. type: Plain text
12077 #: build/C/man7/uri.7:55
12079 msgid "URI = [ absoluteURI | relativeURI ] [ \"#\" fragment ]\n"
12082 #. type: Plain text
12083 #: build/C/man7/uri.7:57
12085 msgid "absoluteURI = scheme \":\" ( hierarchical_part | opaque_part )\n"
12088 #. type: Plain text
12089 #: build/C/man7/uri.7:59
12091 msgid "relativeURI = ( net_path | absolute_path | relative_path ) [ \"?\" query ]\n"
12094 #. type: Plain text
12095 #: build/C/man7/uri.7:62
12098 "scheme = \"http\" | \"ftp\" | \"gopher\" | \"mailto\" | \"news\" | "
12100 " \"file\" | \"man\" | \"info\" | \"whatis\" | \"ldap\" | \"wais\" | "
12104 #. type: Plain text
12105 #: build/C/man7/uri.7:64
12107 msgid "hierarchical_part = ( net_path | absolute_path ) [ \"?\" query ]\n"
12110 #. type: Plain text
12111 #: build/C/man7/uri.7:66
12113 msgid "net_path = \"//\" authority [ absolute_path ]\n"
12116 #. type: Plain text
12117 #: build/C/man7/uri.7:68
12119 msgid "absolute_path = \"/\" path_segments\n"
12122 #. type: Plain text
12123 #: build/C/man7/uri.7:70
12125 msgid "relative_path = relative_segment [ absolute_path ]\n"
12128 #. type: Plain text
12129 #: build/C/man7/uri.7:82
12131 "A Uniform Resource Identifier (URI) is a short string of characters "
12132 "identifying an abstract or physical resource (for example, a web page). A "
12133 "Uniform Resource Locator (URL) is a URI that identifies a resource through "
12134 "its primary access mechanism (e.g., its network \"location\"), rather than "
12135 "by name or some other attribute of that resource. A Uniform Resource Name "
12136 "(URN) is a URI that must remain globally unique and persistent even when the "
12137 "resource ceases to exist or becomes unavailable."
12140 #. type: Plain text
12141 #: build/C/man7/uri.7:89
12143 "URIs are the standard way to name hypertext link destinations for tools such "
12144 "as web browsers. The string \"http://www.kernelnotes.org\" is a URL (and "
12145 "thus it is also a URI). Many people use the term URL loosely as a synonym "
12146 "for URI (though technically URLs are a subset of URIs)."
12149 #. type: Plain text
12150 #: build/C/man7/uri.7:105
12152 "URIs can be absolute or relative. An absolute identifier refers to a "
12153 "resource independent of context, while a relative identifier refers to a "
12154 "resource by describing the difference from the current context. Within a "
12155 "relative path reference, the complete path segments \".\" and \"..\" have "
12156 "special meanings: \"the current hierarchy level\" and \"the level above this "
12157 "hierarchy level\", respectively, just like they do in UNIX-like systems. A "
12158 "path segment which contains a colon character can't be used as the first "
12159 "segment of a relative URI path (e.g., \"this:that\"), because it would be "
12160 "mistaken for a scheme name; precede such segments with ./ (e.g., "
12161 "\"./this:that\"). Note that descendants of MS-DOS (e.g., Microsoft Windows) "
12162 "replace devicename colons with the vertical bar (\"|\") in URIs, so \"C:\" "
12166 #. type: Plain text
12167 #: build/C/man7/uri.7:109
12169 "A fragment identifier, if included, refers to a particular named portion "
12170 "(fragment) of a resource; text after a \\(aq#\\(aq identifies the fragment. "
12171 "A URI beginning with \\(aq#\\(aq refers to that fragment in the current "
12175 #. type: Plain text
12176 #: build/C/man7/uri.7:117
12178 "There are many different URI schemes, each with specific additional rules "
12179 "and meanings, but they are intentionally made to be as similar as possible. "
12180 "For example, many URL schemes permit the authority to be the following "
12181 "format, called here an I<ip_server> (square brackets show what's optional):"
12184 #. type: Plain text
12185 #: build/C/man7/uri.7:119
12186 msgid "I<ip_server = >[I<user> [ : I<password> ] @ ] I<host> [ : I<port>]"
12189 #. type: Plain text
12190 #: build/C/man7/uri.7:135
12192 "This format allows you to optionally insert a username, a user plus "
12193 "password, and/or a port number. The I<host> is the name of the host "
12194 "computer, either its name as determined by DNS or an IP address (numbers "
12195 "separated by periods). Thus the URI "
12196 "E<lt>http://fred:fredpassword@xyz.com:8080/E<gt> logs into a web server on "
12197 "host xyz.com as fred (using fredpassword) using port 8080. Avoid including "
12198 "a password in a URI if possible because of the many security risks of having "
12199 "a password written down. If the URL supplies a username but no password, "
12200 "and the remote server requests a password, the program interpreting the URL "
12201 "should request one from the user."
12204 #. type: Plain text
12205 #: build/C/man7/uri.7:140
12207 "Here are some of the most common schemes in use on UNIX-like systems that "
12208 "are understood by many tools. Note that many tools using URIs also have "
12209 "internal schemes or specialized schemes; see those tools' documentation for "
12210 "information on those schemes."
12213 #. type: Plain text
12214 #: build/C/man7/uri.7:142
12215 msgid "B<http - Web (HTTP) server>"
12218 #. type: Plain text
12219 #: build/C/man7/uri.7:144
12220 msgid "http://I<ip_server>/I<path>"
12223 #. type: Plain text
12224 #: build/C/man7/uri.7:146
12225 msgid "http://I<ip_server>/I<path>?I<query>"
12228 #. type: Plain text
12229 #: build/C/man7/uri.7:154
12231 "This is a URL accessing a web (HTTP) server. The default port is 80. If "
12232 "the path refers to a directory, the web server will choose what to return; "
12233 "usually if there is a file named \"index.html\" or \"index.htm\" its content "
12234 "is returned, otherwise, a list of the files in the current directory (with "
12235 "appropriate links) is generated and returned. An example is "
12236 "E<lt>http://lwn.netE<gt>."
12239 #. type: Plain text
12240 #: build/C/man7/uri.7:177
12242 "A query can be given in the archaic \"isindex\" format, consisting of a word "
12243 "or phrase and not including an equal sign (=). A query can also be in the "
12244 "longer \"GET\" format, which has one or more query entries of the form "
12245 "I<key>=I<value> separated by the ampersand character (&). Note that I<key> "
12246 "can be repeated more than once, though it's up to the web server and its "
12247 "application programs to determine if there's any meaning to that. There is "
12248 "an unfortunate interaction with HTML/XML/SGML and the GET query format; when "
12249 "such URIs with more than one key are embedded in SGML/XML documents "
12250 "(including HTML), the ampersand (&) has to be rewritten as &. Note that "
12251 "not all queries use this format; larger forms may be too long to store as a "
12252 "URI, so they use a different interaction mechanism (called POST) which does "
12253 "not include the data in the URI. See the Common Gateway Interface "
12254 "specification at E<.UR http://www.w3.org\\:/CGI> E<.UE> for more "
12258 #. type: Plain text
12259 #: build/C/man7/uri.7:179
12260 msgid "B<ftp - File Transfer Protocol (FTP)>"
12263 #. type: Plain text
12264 #: build/C/man7/uri.7:181
12265 msgid "ftp://I<ip_server>/I<path>"
12268 #. type: Plain text
12269 #: build/C/man7/uri.7:189
12271 "This is a URL accessing a file through the file transfer protocol (FTP). "
12272 "The default port (for control) is 21. If no username is included, the "
12273 "username \"anonymous\" is supplied, and in that case many clients provide as "
12274 "the password the requestor's Internet email address. An example is "
12275 "E<lt>ftp://ftp.is.co.za/rfc/rfc1808.txtE<gt>."
12278 #. type: Plain text
12279 #: build/C/man7/uri.7:191
12280 msgid "B<gopher - Gopher server>"
12283 #. type: Plain text
12284 #: build/C/man7/uri.7:193
12285 msgid "gopher://I<ip_server>/I<gophertype selector>"
12288 #. type: Plain text
12289 #: build/C/man7/uri.7:195
12290 msgid "gopher://I<ip_server>/I<gophertype selector>%09I<search>"
12293 #. type: Plain text
12294 #: build/C/man7/uri.7:197
12295 msgid "gopher://I<ip_server>/I<gophertype selector>%09I<search>%09I<gopher+_string>"
12298 #. type: Plain text
12299 #: build/C/man7/uri.7:207
12301 "The default gopher port is 70. I<gophertype> is a single-character field to "
12302 "denote the Gopher type of the resource to which the URL refers. The entire "
12303 "path may also be empty, in which case the delimiting \"/\" is also optional "
12304 "and the gophertype defaults to \"1\"."
12307 #. type: Plain text
12308 #: build/C/man7/uri.7:214
12310 "I<selector> is the Gopher selector string. In the Gopher protocol, Gopher "
12311 "selector strings are a sequence of octets which may contain any octets "
12312 "except 09 hexadecimal (US-ASCII HT or tab), 0A hexadecimal (US-ASCII "
12313 "character LF), and 0D (US-ASCII character CR)."
12316 #. type: Plain text
12317 #: build/C/man7/uri.7:216
12318 msgid "B<mailto - Email address>"
12321 #. type: Plain text
12322 #: build/C/man7/uri.7:218
12323 msgid "mailto:I<email-address>"
12326 #. type: Plain text
12327 #: build/C/man7/uri.7:226
12329 "This is an email address, usually of the form I<name>@I<hostname>. See "
12330 "B<mailaddr>(7) for more information on the correct format of an email "
12331 "address. Note that any % character must be rewritten as %25. An example is "
12332 "E<lt>mailto:dwheeler@dwheeler.comE<gt>."
12335 #. type: Plain text
12336 #: build/C/man7/uri.7:228
12337 msgid "B<news - Newsgroup or News message>"
12340 #. type: Plain text
12341 #: build/C/man7/uri.7:230
12342 msgid "news:I<newsgroup-name>"
12345 #. type: Plain text
12346 #: build/C/man7/uri.7:232
12347 msgid "news:I<message-id>"
12350 #. type: Plain text
12351 #: build/C/man7/uri.7:240
12353 "A I<newsgroup-name> is a period-delimited hierarchical name, such as "
12354 "\"comp.infosystems.www.misc\". If E<lt>newsgroup-nameE<gt> is \"*\" (as in "
12355 "E<lt>news:*E<gt>), it is used to refer to \"all available news groups\". An "
12356 "example is E<lt>news:comp.lang.adaE<gt>."
12359 #. type: Plain text
12360 #: build/C/man7/uri.7:252
12362 "A I<message-id> corresponds to the Message-ID of E<.UR "
12363 "http://www.ietf.org\\:/rfc\\:/rfc1036.txt> IETF RFC\\ 1036, E<.UE> without "
12364 "the enclosing \"E<lt>\" and \"E<gt>\"; it takes the form "
12365 "I<unique>@I<full_domain_name>. A message identifier may be distinguished "
12366 "from a news group name by the presence of the \"@\" character."
12369 #. type: Plain text
12370 #: build/C/man7/uri.7:254
12371 msgid "B<telnet - Telnet login>"
12374 #. type: Plain text
12375 #: build/C/man7/uri.7:256
12376 msgid "telnet://I<ip_server>/"
12379 #. type: Plain text
12380 #: build/C/man7/uri.7:262
12382 "The Telnet URL scheme is used to designate interactive text services that "
12383 "may be accessed by the Telnet protocol. The final \"/\" character may be "
12384 "omitted. The default port is 23. An example is "
12385 "E<lt>telnet://melvyl.ucop.edu/E<gt>."
12388 #. type: Plain text
12389 #: build/C/man7/uri.7:264
12390 msgid "B<file - Normal file>"
12393 #. type: Plain text
12394 #: build/C/man7/uri.7:266
12395 msgid "file://I<ip_server>/I<path_segments>"
12398 #. type: Plain text
12399 #: build/C/man7/uri.7:268
12400 msgid "file:I<path_segments>"
12403 #. type: Plain text
12404 #: build/C/man7/uri.7:285
12406 "This represents a file or directory accessible locally. As a special case, "
12407 "I<ip_server> can be the string \"localhost\" or the empty string; this is "
12408 "interpreted as \"the machine from which the URL is being interpreted\". If "
12409 "the path is to a directory, the viewer should display the directory's "
12410 "contents with links to each containee; not all viewers currently do this. "
12411 "KDE supports generated files through the URL E<lt>file:/cgi-binE<gt>. If "
12412 "the given file isn't found, browser writers may want to try to expand the "
12413 "filename via filename globbing (see B<glob>(7) and B<glob>(3))."
12416 #. type: Plain text
12417 #: build/C/man7/uri.7:299
12419 "The second format (e.g., E<lt>file:/etc/passwdE<gt>) is a correct format "
12420 "for referring to a local file. However, older standards did not permit this "
12421 "format, and some programs don't recognize this as a URI. A more portable "
12422 "syntax is to use an empty string as the server name, for example, "
12423 "E<lt>file:///etc/passwdE<gt>; this form does the same thing and is easily "
12424 "recognized by pattern matchers and older programs as a URI. Note that if "
12425 "you really mean to say \"start from the current location,\" don't specify "
12426 "the scheme at all; use a relative address like E<lt>../test.txtE<gt>, which "
12427 "has the side-effect of being scheme-independent. An example of this scheme "
12428 "is E<lt>file:///etc/passwdE<gt>."
12431 #. type: Plain text
12432 #: build/C/man7/uri.7:301
12433 msgid "B<man - Man page documentation>"
12436 #. type: Plain text
12437 #: build/C/man7/uri.7:303
12438 msgid "man:I<command-name>"
12441 #. type: Plain text
12442 #: build/C/man7/uri.7:305
12443 msgid "man:I<command-name>(I<section>)"
12446 #. type: Plain text
12447 #: build/C/man7/uri.7:314
12449 "This refers to local online manual (man) reference pages. The command name "
12450 "can optionally be followed by a parenthesis and section number; see "
12451 "B<man>(7) for more information on the meaning of the section numbers. This "
12452 "URI scheme is unique to UNIX-like systems (such as Linux) and is not "
12453 "currently registered by the IETF. An example is E<lt>man:ls(1)E<gt>."
12456 #. type: Plain text
12457 #: build/C/man7/uri.7:316
12458 msgid "B<info - Info page documentation>"
12461 #. type: Plain text
12462 #: build/C/man7/uri.7:318
12463 msgid "info:I<virtual-filename>"
12466 #. type: Plain text
12467 #: build/C/man7/uri.7:320
12468 msgid "info:I<virtual-filename>#I<nodename>"
12471 #. type: Plain text
12472 #: build/C/man7/uri.7:322
12473 msgid "info:(I<virtual-filename>)"
12476 #. type: Plain text
12477 #: build/C/man7/uri.7:324
12478 msgid "info:(I<virtual-filename>)I<nodename>"
12481 #. type: Plain text
12482 #: build/C/man7/uri.7:343
12484 "This scheme refers to online info reference pages (generated from texinfo "
12485 "files), a documentation format used by programs such as the GNU tools. This "
12486 "URI scheme is unique to UNIX-like systems (such as Linux) and is not "
12487 "currently registered by the IETF. As of this writing, GNOME and KDE differ "
12488 "in their URI syntax and do not accept the other's syntax. The first two "
12489 "formats are the GNOME format; in nodenames all spaces are written as "
12490 "underscores. The second two formats are the KDE format; spaces in nodenames "
12491 "must be written as spaces, even though this is forbidden by the URI "
12492 "standards. It's hoped that in the future most tools will understand all of "
12493 "these formats and will always accept underscores for spaces in nodenames. "
12494 "In both GNOME and KDE, if the form without the nodename is used the nodename "
12495 "is assumed to be \"Top\". Examples of the GNOME format are "
12496 "E<lt>info:gccE<gt> and E<lt>info:gcc#G++_and_GCCE<gt>. Examples of the KDE "
12497 "format are E<lt>info:(gcc)E<gt> and E<lt>info:(gcc)G++ and GCCE<gt>."
12500 #. type: Plain text
12501 #: build/C/man7/uri.7:345
12502 msgid "B<whatis - Documentation search>"
12505 #. type: Plain text
12506 #: build/C/man7/uri.7:347
12507 msgid "whatis:I<string>"
12510 #. type: Plain text
12511 #: build/C/man7/uri.7:355
12513 "This scheme searches the database of short (one-line) descriptions of "
12514 "commands and returns a list of descriptions containing that string. Only "
12515 "complete word matches are returned. See B<whatis>(1). This URI scheme is "
12516 "unique to UNIX-like systems (such as Linux) and is not currently registered "
12520 #. type: Plain text
12521 #: build/C/man7/uri.7:357
12522 msgid "B<ghelp - GNOME help documentation>"
12525 #. type: Plain text
12526 #: build/C/man7/uri.7:359
12527 msgid "ghelp:I<name-of-application>"
12530 #. type: Plain text
12531 #: build/C/man7/uri.7:362
12533 "This loads GNOME help for the given application. Note that not much "
12534 "documentation currently exists in this format."
12537 #. type: Plain text
12538 #: build/C/man7/uri.7:364
12539 msgid "B<ldap - Lightweight Directory Access Protocol>"
12542 #. type: Plain text
12543 #: build/C/man7/uri.7:366
12544 msgid "ldap://I<hostport>"
12547 #. type: Plain text
12548 #: build/C/man7/uri.7:368
12549 msgid "ldap://I<hostport>/"
12552 #. type: Plain text
12553 #: build/C/man7/uri.7:370
12554 msgid "ldap://I<hostport>/I<dn>"
12557 #. type: Plain text
12558 #: build/C/man7/uri.7:372
12559 msgid "ldap://I<hostport>/I<dn>?I<attributes>"
12562 #. type: Plain text
12563 #: build/C/man7/uri.7:374
12564 msgid "ldap://I<hostport>/I<dn>?I<attributes>?I<scope>"
12567 #. type: Plain text
12568 #: build/C/man7/uri.7:376
12569 msgid "ldap://I<hostport>/I<dn>?I<attributes>?I<scope>?I<filter>"
12572 #. type: Plain text
12573 #: build/C/man7/uri.7:378
12574 msgid "ldap://I<hostport>/I<dn>?I<attributes>?I<scope>?I<filter>?I<extensions>"
12577 #. type: Plain text
12578 #: build/C/man7/uri.7:389
12580 "This scheme supports queries to the Lightweight Directory Access Protocol "
12581 "(LDAP), a protocol for querying a set of servers for hierarchically "
12582 "organized information (such as people and computing resources). See E<.UR "
12583 "http://www.ietf.org\\:/rfc\\:/rfc2255.txt> RFC\\ 2255 E<.UE> for more "
12584 "information on the LDAP URL scheme. The components of this URL are:"
12588 #: build/C/man7/uri.7:389
12593 #. type: Plain text
12594 #: build/C/man7/uri.7:394
12596 "the LDAP server to query, written as a hostname optionally followed by a "
12597 "colon and the port number. The default LDAP port is TCP port 389. If "
12598 "empty, the client determines which the LDAP server to use."
12602 #: build/C/man7/uri.7:394
12607 #. type: Plain text
12608 #: build/C/man7/uri.7:401
12610 "the LDAP Distinguished Name, which identifies the base object of the LDAP "
12611 "search (see E<.UR http://www.ietf.org\\:/rfc\\:/rfc2253.txt> RFC\\ 2253 "
12612 "E<.UE> section 3)."
12616 #: build/C/man7/uri.7:401
12621 #. type: Plain text
12622 #: build/C/man7/uri.7:405
12624 "a comma-separated list of attributes to be returned; see RFC\\ 2251 section "
12625 "4.1.5. If omitted, all attributes should be returned."
12629 #: build/C/man7/uri.7:405
12634 #. type: Plain text
12635 #: build/C/man7/uri.7:410
12637 "specifies the scope of the search, which can be one of \"base\" (for a base "
12638 "object search), \"one\" (for a one-level search), or \"sub\" (for a subtree "
12639 "search). If scope is omitted, \"base\" is assumed."
12643 #: build/C/man7/uri.7:410
12648 #. type: Plain text
12649 #: build/C/man7/uri.7:419
12651 "specifies the search filter (subset of entries to return). If omitted, all "
12652 "entries should be returned. See E<.UR "
12653 "http://www.ietf.org\\:/rfc\\:/rfc2254.txt> RFC\\ 2254 E<.UE> section 4."
12657 #: build/C/man7/uri.7:419
12662 #. type: Plain text
12663 #: build/C/man7/uri.7:425
12665 "a comma-separated list of type=value pairs, where the =value portion may be "
12666 "omitted for options not requiring it. An extension prefixed with a "
12667 "\\(aq!\\(aq is critical (must be supported to be valid), otherwise it is "
12668 "noncritical (optional)."
12671 #. type: Plain text
12672 #: build/C/man7/uri.7:429
12674 "LDAP queries are easiest to explain by example. Here's a query that asks "
12675 "ldap.itd.umich.edu for information about the University of Michigan in the "
12679 #. type: Plain text
12680 #: build/C/man7/uri.7:432
12682 msgid "ldap://ldap.itd.umich.edu/o=University%20of%20Michigan,c=US\n"
12685 #. type: Plain text
12686 #: build/C/man7/uri.7:435
12687 msgid "To just get its postal address attribute, request:"
12690 #. type: Plain text
12691 #: build/C/man7/uri.7:438
12693 msgid "ldap://ldap.itd.umich.edu/o=University%20of%20Michigan,c=US?postalAddress\n"
12696 #. type: Plain text
12697 #: build/C/man7/uri.7:442
12699 "To ask a host.com at port 6666 for information about the person with common "
12700 "name (cn) \"Babs Jensen\" at University of Michigan, request:"
12703 #. type: Plain text
12704 #: build/C/man7/uri.7:445
12706 msgid "ldap://host.com:6666/o=University%20of%20Michigan,c=US??sub?(cn=Babs%20Jensen)\n"
12709 #. type: Plain text
12710 #: build/C/man7/uri.7:448
12711 msgid "B<wais - Wide Area Information Servers>"
12714 #. type: Plain text
12715 #: build/C/man7/uri.7:450
12716 msgid "wais://I<hostport>/I<database>"
12719 #. type: Plain text
12720 #: build/C/man7/uri.7:452
12721 msgid "wais://I<hostport>/I<database>?I<search>"
12724 #. type: Plain text
12725 #: build/C/man7/uri.7:454
12726 msgid "wais://I<hostport>/I<database>/I<wtype>/I<wpath>"
12729 #. type: Plain text
12730 #: build/C/man7/uri.7:463
12732 "This scheme designates a WAIS database, search, or document (see E<.UR "
12733 "http://www.ietf.org\\:/rfc\\:/rfc1625.txt> IETF RFC\\ 1625 E<.UE> for more "
12734 "information on WAIS). Hostport is the hostname, optionally followed by a "
12735 "colon and port number (the default port number is 210)."
12738 #. type: Plain text
12739 #: build/C/man7/uri.7:473
12741 "The first form designates a WAIS database for searching. The second form "
12742 "designates a particular search of the WAIS database I<database>. The third "
12743 "form designates a particular document within a WAIS database to be "
12744 "retrieved. I<wtype> is the WAIS designation of the type of the object and "
12745 "I<wpath> is the WAIS document-id."
12748 #. type: Plain text
12749 #: build/C/man7/uri.7:475
12750 msgid "B<other schemes>"
12753 #. type: Plain text
12754 #: build/C/man7/uri.7:489
12756 "There are many other URI schemes. Most tools that accept URIs support a set "
12757 "of internal URIs (e.g., Mozilla has the about: scheme for internal "
12758 "information, and the GNOME help browser has the toc: scheme for various "
12759 "starting locations). There are many schemes that have been defined but are "
12760 "not as widely used at the current time (e.g., prospero). The nntp: scheme "
12761 "is deprecated in favor of the news: scheme. URNs are to be supported by the "
12762 "urn: scheme, with a hierarchical name space (e.g., urn:ietf:... would "
12763 "identify IETF documents); at this time URNs are not widely implemented. Not "
12764 "all tools support all schemes."
12768 #: build/C/man7/uri.7:489
12770 msgid "Character encoding"
12773 #. type: Plain text
12774 #: build/C/man7/uri.7:493
12776 "URIs use a limited number of characters so that they can be typed in and "
12777 "used in a variety of situations."
12780 #. type: Plain text
12781 #: build/C/man7/uri.7:497
12783 "The following characters are reserved, that is, they may appear in a URI but "
12784 "their use is limited to their reserved purpose (conflicting data must be "
12785 "escaped before forming the URI):"
12788 #. type: Plain text
12789 #: build/C/man7/uri.7:499
12791 msgid " ; / ? : @ & = + $ ,\n"
12794 #. type: Plain text
12795 #: build/C/man7/uri.7:505
12797 "Unreserved characters may be included in a URI. Unreserved characters "
12798 "include upper and lower case English letters, decimal digits, and the "
12799 "following limited set of punctuation marks and symbols:"
12802 #. type: Plain text
12803 #: build/C/man7/uri.7:507
12805 msgid " - _ . ! ~ * ' ( )\n"
12808 #. type: Plain text
12809 #: build/C/man7/uri.7:522
12811 "All other characters must be escaped. An escaped octet is encoded as a "
12812 "character triplet, consisting of the percent character \"%\" followed by the "
12813 "two hexadecimal digits representing the octet code (you can use upper or "
12814 "lower case letters for the hexadecimal digits). For example, a blank space "
12815 "must be escaped as \"%20\", a tab character as \"%09\", and the \"&\" as "
12816 "\"%26\". Because the percent \"%\" character always has the reserved "
12817 "purpose of being the escape indicator, it must be escaped as \"%25\". It is "
12818 "common practice to escape space characters as the plus symbol (+) in query "
12819 "text; this practice isn't uniformly defined in the relevant RFCs (which "
12820 "recommend %20 instead) but any tool accepting URIs with query text should be "
12821 "prepared for them. A URI is always shown in its \"escaped\" form."
12824 #. type: Plain text
12825 #: build/C/man7/uri.7:528
12827 "Unreserved characters can be escaped without changing the semantics of the "
12828 "URI, but this should not be done unless the URI is being used in a context "
12829 "that does not allow the unescaped character to appear. For example, \"%7e\" "
12830 "is sometimes used instead of \"~\" in an HTTP URL path, but the two are "
12831 "equivalent for an HTTP URL."
12834 #. type: Plain text
12835 #: build/C/man7/uri.7:532
12837 "For URIs which must handle characters outside the US ASCII character set, "
12838 "the HTML 4.01 specification (section B.2) and IETF RFC\\ 2718 (section "
12839 "2.2.5) recommend the following approach:"
12842 #. type: Plain text
12843 #: build/C/man7/uri.7:536
12845 "translate the character sequences into UTF-8 (IETF RFC\\ 2279)\\(emsee "
12846 "B<utf-8>(7)\\(emand then"
12849 #. type: Plain text
12850 #: build/C/man7/uri.7:539
12852 "use the URI escaping mechanism, that is, use the %HH encoding for unsafe "
12857 #: build/C/man7/uri.7:539
12859 msgid "Writing a URI"
12862 #. type: Plain text
12863 #: build/C/man7/uri.7:562
12865 "When written, URIs should be placed inside double quotes (e.g., "
12866 "\"http://www.kernelnotes.org\"), enclosed in angle brackets (e.g., "
12867 "E<lt>http://lwn.netE<gt>), or placed on a line by themselves. A warning for "
12868 "those who use double-quotes: B<never> move extraneous punctuation (such as "
12869 "the period ending a sentence or the comma in a list) inside a URI, since "
12870 "this will change the value of the URI. Instead, use angle brackets instead, "
12871 "or switch to a quoting system that never includes extraneous characters "
12872 "inside quotation marks. This latter system, called the 'new' or 'logical' "
12873 "quoting system by \"Hart's Rules\" and the \"Oxford Dictionary for Writers "
12874 "and Editors\", is preferred practice in Great Britain and hackers worldwide "
12875 "(see the Jargon File's section on Hacker Writing Style, E<.UR "
12876 "http://www.fwi.uva.nl\\:/~mes\\:/jargon\\:/h\\:/HackerWritingStyle.html> "
12877 "E<.UE ,> for more information). Older documents suggested inserting the "
12878 "prefix \"URL:\" just before the URI, but this form has never caught on."
12881 #. type: Plain text
12882 #: build/C/man7/uri.7:584
12884 "The URI syntax was designed to be unambiguous. However, as URIs have become "
12885 "commonplace, traditional media (television, radio, newspapers, billboards, "
12886 "etc.) have increasingly used abbreviated URI references consisting of only "
12887 "the authority and path portions of the identified resource (e.g., "
12888 "E<lt>www.w3.org/AddressingE<gt>). Such references are primarily intended "
12889 "for human interpretation rather than machine, with the assumption that "
12890 "context-based heuristics are sufficient to complete the URI (e.g., hostnames "
12891 "beginning with \"www\" are likely to have a URI prefix of \"http://\" and "
12892 "hostnames beginning with \"ftp\" likely to have a prefix of \"ftp://\"). "
12893 "Many client implementations heuristically resolve these references. Such "
12894 "heuristics may change over time, particularly when new schemes are "
12895 "introduced. Since an abbreviated URI has the same syntax as a relative URL "
12896 "path, abbreviated URI references cannot be used where relative URIs are "
12897 "permitted, and can be used only when there is no defined base (such as in "
12898 "dialog boxes). Don't use abbreviated URIs as hypertext links inside a "
12899 "document; use the standard format as described here."
12902 #. type: Plain text
12903 #: build/C/man7/uri.7:592
12905 "E<.UR http://www.ietf.org\\:/rfc\\:/rfc2396.txt> (IETF RFC\\ 2396) E<.UE ,> "
12906 "E<.UR http://www.w3.org\\:/TR\\:/REC-html40> (HTML 4.0) E<.UE .>"
12909 #. type: Plain text
12910 #: build/C/man7/uri.7:598
12912 "Any tool accepting URIs (e.g., a web browser) on a Linux system should be "
12913 "able to handle (directly or indirectly) all of the schemes described here, "
12914 "including the man: and info: schemes. Handling them by invoking some other "
12915 "program is fine and in fact encouraged."
12918 #. type: Plain text
12919 #: build/C/man7/uri.7:600
12920 msgid "Technically the fragment isn't part of the URI."
12923 #. type: Plain text
12924 #: build/C/man7/uri.7:609
12926 "For information on how to embed URIs (including URLs) in a data format, see "
12927 "documentation on that format. HTML uses the format E<lt>A "
12928 "HREF=\"I<uri>\"E<gt> I<text> E<lt>/AE<gt>. Texinfo files use the format "
12929 "@uref{I<uri>}. Man and mdoc have the recently added UR macro, or just "
12930 "include the URI in the text (viewers should be able to detect :// as part of "
12934 #. type: Plain text
12935 #: build/C/man7/uri.7:630
12937 "The GNOME and KDE desktop environments currently vary in the URIs they "
12938 "accept, in particular in their respective help browsers. To list man pages, "
12939 "GNOME uses E<lt>toc:manE<gt> while KDE uses E<lt>man:(index)E<gt>, and to "
12940 "list info pages, GNOME uses E<lt>toc:infoE<gt> while KDE uses "
12941 "E<lt>info:(dir)E<gt> (the author of this man page prefers the KDE approach "
12942 "here, though a more regular format would be even better). In general, KDE "
12943 "uses E<lt>file:/cgi-bin/E<gt> as a prefix to a set of generated files. KDE "
12944 "prefers documentation in HTML, accessed via the "
12945 "E<lt>file:/cgi-bin/helpindexE<gt>. GNOME prefers the ghelp scheme to store "
12946 "and find documentation. Neither browser handles file: references to "
12947 "directories at the time of this writing, making it difficult to refer to an "
12948 "entire directory with a browsable URI. As noted above, these environments "
12949 "differ in how they handle the info: scheme, probably the most important "
12950 "variation. It is expected that GNOME and KDE will converge to common URI "
12951 "formats, and a future version of this man page will describe the converged "
12952 "result. Efforts to aid this convergence are encouraged."
12956 #: build/C/man7/uri.7:630
12961 #. type: Plain text
12962 #: build/C/man7/uri.7:640
12964 "A URI does not in itself pose a security threat. There is no general "
12965 "guarantee that a URL, which at one time located a given resource, will "
12966 "continue to do so. Nor is there any guarantee that a URL will not locate a "
12967 "different resource at some later point in time; such a guarantee can be "
12968 "obtained only from the person(s) controlling that namespace and the resource "
12972 #. type: Plain text
12973 #: build/C/man7/uri.7:655
12975 "It is sometimes possible to construct a URL such that an attempt to perform "
12976 "a seemingly harmless operation, such as the retrieval of an entity "
12977 "associated with the resource, will in fact cause a possibly damaging remote "
12978 "operation to occur. The unsafe URL is typically constructed by specifying a "
12979 "port number other than that reserved for the network protocol in question. "
12980 "The client unwittingly contacts a site that is in fact running a different "
12981 "protocol. The content of the URL contains instructions that, when "
12982 "interpreted according to this other protocol, cause an unexpected "
12983 "operation. An example has been the use of a gopher URL to cause an "
12984 "unintended or impersonating message to be sent via a SMTP server."
12987 #. type: Plain text
12988 #: build/C/man7/uri.7:659
12990 "Caution should be used when using any URL that specifies a port number other "
12991 "than the default for the protocol, especially when it is a number within the "
12995 #. type: Plain text
12996 #: build/C/man7/uri.7:667
12998 "Care should be taken when a URI contains escaped delimiters for a given "
12999 "protocol (for example, CR and LF characters for telnet protocols) that these "
13000 "are not unescaped before transmission. This might violate the protocol, but "
13001 "avoids the potential for such characters to be used to simulate an extra "
13002 "operation or parameter in that protocol, which might lead to an unexpected "
13003 "and possibly harmful remote operation to be performed."
13006 #. type: Plain text
13007 #: build/C/man7/uri.7:673
13009 "It is clearly unwise to use a URI that contains a password which is intended "
13010 "to be secret. In particular, the use of a password within the \"userinfo\" "
13011 "component of a URI is strongly recommended against except in those rare "
13012 "cases where the \"password\" parameter is intended to be public."
13015 #. type: Plain text
13016 #: build/C/man7/uri.7:695
13018 "Documentation may be placed in a variety of locations, so there currently "
13019 "isn't a good URI scheme for general online documentation in arbitrary "
13020 "formats. References of the form E<lt>file:///usr/doc/ZZZE<gt> don't work "
13021 "because different distributions and local installation requirements may "
13022 "place the files in different directories (it may be in /usr/doc, or "
13023 "/usr/local/doc, or /usr/share, or somewhere else). Also, the directory ZZZ "
13024 "usually changes when a version changes (though filename globbing could "
13025 "partially overcome this). Finally, using the file: scheme doesn't easily "
13026 "support people who dynamically load documentation from the Internet (instead "
13027 "of loading the files onto a local filesystem). A future URI scheme may be "
13028 "added (e.g., \"userdoc:\") to permit programs to include cross-references to "
13029 "more detailed documentation without having to know the exact location of "
13030 "that documentation. Alternatively, a future version of the filesystem "
13031 "specification may specify file locations sufficiently so that the file: "
13032 "scheme will be able to locate documentation."
13035 #. type: Plain text
13036 #: build/C/man7/uri.7:698
13038 "Many programs and file formats don't include a way to incorporate or "
13039 "implement links using URIs."
13043 #. David A. Wheeler (dwheeler@dwheeler.com) wrote this man page.
13044 #. type: Plain text
13045 #: build/C/man7/uri.7:706
13047 "Many programs can't handle all of these different URI formats; there should "
13048 "be a standard mechanism to load an arbitrary URI that automatically detects "
13049 "the users' environment (e.g., text or graphics, desktop environment, local "
13050 "user preferences, and currently executing tools) and invokes the right tool "
13054 #. type: Plain text
13055 #: build/C/man7/uri.7:711
13056 msgid "B<lynx>(1), B<man2html>(1), B<mailaddr>(7), B<utf-8>(7)"
13059 #. type: Plain text
13060 #: build/C/man7/uri.7:715
13061 msgid "E<.UR http://www.ietf.org\\:/rfc\\:/rfc2255.txt> IETF RFC\\ 2255 E<.UE>"
13065 #: build/C/man4/vcs.4:29
13071 #: build/C/man4/vcs.4:29
13076 #. type: Plain text
13077 #: build/C/man4/vcs.4:32
13078 msgid "vcs, vcsa - virtual console memory"
13081 #. type: Plain text
13082 #: build/C/man4/vcs.4:38
13084 "I</dev/vcs0> is a character device with major number 7 and minor number 0, "
13085 "usually of mode 0644 and owner root.tty. It refers to the memory of the "
13086 "currently displayed virtual console terminal."
13089 #. type: Plain text
13090 #: build/C/man4/vcs.4:58
13092 "I</dev/vcs[1-63]> are character devices for virtual console terminals, they "
13093 "have major number 7 and minor number 1 to 63, usually mode 0644 and owner "
13094 "root.tty. I</dev/vcsa[0-63]> are the same, but using I<unsigned short>s (in "
13095 "host byte order) that include attributes, and prefixed with four bytes "
13096 "giving the screen dimensions and cursor position: I<lines>, I<columns>, "
13097 "I<x>, I<y>. (I<x> = I<y> = 0 at the top left corner of the screen.)"
13100 #. type: Plain text
13101 #: build/C/man4/vcs.4:72
13103 "When a 512-character font is loaded, the 9th bit position can be fetched by "
13104 "applying the B<ioctl>(2) B<VT_GETHIFONTMASK> operation (available in Linux "
13105 "kernels 2.6.18 and above) on I</dev/tty[1-63]>; the value is returned in "
13106 "the I<unsigned short> pointed to by the third B<ioctl>(2) argument."
13109 #. type: Plain text
13110 #: build/C/man4/vcs.4:79
13112 "These devices replace the screendump B<ioctl>(2) operations of "
13113 "B<console>(4), so the system administrator can control access using "
13114 "filesystem permissions."
13117 #. type: Plain text
13118 #: build/C/man4/vcs.4:81
13119 msgid "The devices for the first eight virtual consoles may be created by:"
13122 #. type: Plain text
13123 #: build/C/man4/vcs.4:88
13126 " for x in 0 1 2 3 4 5 6 7 8; do\n"
13127 " mknod -m 644 /dev/vcs$x c 7 $x;\n"
13128 " mknod -m 644 /dev/vcsa$x c 7 $[$x+128];\n"
13130 " chown root:tty /dev/vcs*\n"
13133 #. type: Plain text
13134 #: build/C/man4/vcs.4:93
13135 msgid "No B<ioctl>(2) requests are supported."
13138 #. type: Plain text
13139 #: build/C/man4/vcs.4:95
13140 msgid "/dev/vcs[0-63]"
13144 #. Andries Brouwer <aeb@cwi.nl>
13145 #. type: Plain text
13146 #: build/C/man4/vcs.4:99
13147 msgid "/dev/vcsa[0-63]"
13150 #. type: Plain text
13151 #: build/C/man4/vcs.4:101
13152 msgid "Introduced with version 1.1.92 of the Linux kernel."
13155 #. type: Plain text
13156 #: build/C/man4/vcs.4:103
13157 msgid "You may do a screendump on vt3 by switching to vt1 and typing"
13160 #. type: Plain text
13161 #: build/C/man4/vcs.4:105
13163 msgid " cat /dev/vcs3 E<gt>foo\n"
13166 #. type: Plain text
13167 #: build/C/man4/vcs.4:109
13169 "Note that the output does not contain newline characters, so some processing "
13170 "may be required, like in"
13173 #. type: Plain text
13174 #: build/C/man4/vcs.4:111
13176 msgid " old -w 81 /dev/vcs3 | lpr\n"
13179 #. type: Plain text
13180 #: build/C/man4/vcs.4:113
13181 msgid "or (horrors)"
13184 #. type: Plain text
13185 #: build/C/man4/vcs.4:115
13187 msgid " xetterm -dump 3 -file /proc/self/fd/1\n"
13190 #. type: Plain text
13191 #: build/C/man4/vcs.4:120
13192 msgid "The I</dev/vcsa0> device is used for Braille support."
13195 #. type: Plain text
13196 #: build/C/man4/vcs.4:124
13198 "This program displays the character and screen attributes under the cursor "
13199 "of the second virtual console, then changes the background color there:"
13202 #. type: Plain text
13203 #: build/C/man4/vcs.4:132
13206 "#include E<lt>unistd.hE<gt>\n"
13207 "#include E<lt>stdlib.hE<gt>\n"
13208 "#include E<lt>stdio.hE<gt>\n"
13209 "#include E<lt>fcntl.hE<gt>\n"
13210 "#include E<lt>sys/ioctl.hE<gt>\n"
13211 "#include E<lt>linux/vt.hE<gt>\n"
13214 #. type: Plain text
13215 #: build/C/man4/vcs.4:143
13222 " char *device = \"/dev/vcsa2\";\n"
13223 " char *console = \"/dev/tty2\";\n"
13224 " struct {unsigned char lines, cols, x, y;} scrn;\n"
13225 " unsigned short s;\n"
13226 " unsigned short mask;\n"
13227 " unsigned char ch, attrib;\n"
13230 #. type: Plain text
13231 #: build/C/man4/vcs.4:172
13234 " fd = open(console, O_RDWR);\n"
13235 " if (fd E<lt> 0) {\n"
13236 " perror(console);\n"
13237 " exit(EXIT_FAILURE);\n"
13239 " if (ioctl(fd, VT_GETHIFONTMASK, &mask) E<lt> 0) {\n"
13240 " perror(\"VT_GETHIFONTMASK\");\n"
13241 " exit(EXIT_FAILURE);\n"
13243 " (void) close(fd);\n"
13244 " fd = open(device, O_RDWR);\n"
13245 " if (fd E<lt> 0) {\n"
13246 " perror(device);\n"
13247 " exit(EXIT_FAILURE);\n"
13249 " (void) read(fd, &scrn, 4);\n"
13250 " (void) lseek(fd, 4 + 2*(scrn.y*scrn.cols + scrn.x), 0);\n"
13251 " (void) read(fd, &s, 2);\n"
13252 " ch = s & 0xff;\n"
13253 " if (attrib & mask)\n"
13255 " attrib = ((s & ~mask) E<gt>E<gt> 8);\n"
13256 " printf(\"ch=\\(aq%c\\(aq attrib=0x%02x\\en\", ch, attrib);\n"
13257 " attrib ^= 0x10;\n"
13258 " (void) lseek(fd, -1, 1);\n"
13259 " (void) write(fd, &attrib, 1);\n"
13260 " exit(EXIT_SUCCESS);\n"
13264 #. type: Plain text
13265 #: build/C/man4/vcs.4:178
13266 msgid "B<console>(4), B<tty>(4), B<ttyS>(4), B<gpm>(8)"
13270 #: build/C/man4/wavelan.4:15
13276 #: build/C/man4/wavelan.4:15
13281 #. type: Plain text
13282 #: build/C/man4/wavelan.4:18
13283 msgid "wavelan - AT&T GIS WaveLAN ISA device driver"
13286 #. type: Plain text
13287 #: build/C/man4/wavelan.4:20
13289 "B<insmod wavelan_cs.o [io=>I<B,B..>B<] [ irq=>I<I,I..>B<] "
13290 "[name=>I<N,N..>B<]>"
13293 #. type: Plain text
13294 #: build/C/man4/wavelan.4:23
13296 "I<This driver is obsolete:> it was removed from the kernel in version "
13300 #. type: Plain text
13301 #: build/C/man4/wavelan.4:39
13303 "I<wavelan> is the low-level device driver for the NCR / AT&T / Lucent "
13304 "B<WaveLAN ISA> and Digital (DEC) B<RoamAbout DS> wireless ethernet "
13305 "adapter. This driver is available as a module or might be compiled in the "
13306 "kernel. This driver supports multiple cards in both forms (up to 4) and "
13307 "allocates the next available ethernet device (eth0..eth#) for each card "
13308 "found, unless a device name is explicitly specified (see below). This "
13309 "device name will be reported in the kernel log file with the MAC address, "
13310 "NWID and frequency used by the card."
13313 #. type: Plain text
13314 #: build/C/man4/wavelan.4:46
13316 "This section apply to the module form (parameters passed on the B<insmod>(8) "
13317 "command line). If the driver is included in the kernel, use the "
13318 "I<ether=IRQ,IO,NAME> syntax on the kernel command line."
13322 #: build/C/man4/wavelan.4:46
13327 #. type: Plain text
13328 #: build/C/man4/wavelan.4:53
13330 "Specify the list of base address where to search for wavelan cards (setting "
13331 "by dip switch on the card). If you don't specify any io address, the driver "
13332 "will scan 0x390 and 0x3E0 addresses, which might conflict with other "
13337 #: build/C/man4/wavelan.4:53
13342 #. type: Plain text
13343 #: build/C/man4/wavelan.4:57
13345 "Set the list of irq that each wavelan card should use (the value is saved in "
13346 "permanent storage for future use)."
13350 #: build/C/man4/wavelan.4:57
13355 #. type: Plain text
13356 #: build/C/man4/wavelan.4:62
13358 "Set the list of name to be used for each wavelan cards device (name used by "
13363 #: build/C/man4/wavelan.4:62
13365 msgid "Wireless extensions"
13368 #. type: Plain text
13369 #: build/C/man4/wavelan.4:66
13370 msgid "Use B<iwconfig>(8) to manipulate wireless extensions."
13374 #: build/C/man4/wavelan.4:66
13376 msgid "NWID (or domain)"
13379 #. type: Plain text
13380 #: build/C/man4/wavelan.4:75
13382 "Set the network ID [I<0> to I<FFFF>] or disable it [I<off>]. As the NWID is "
13383 "stored in the card Permanent Storage Area, it will be reuse at any further "
13384 "invocation of the driver."
13388 #: build/C/man4/wavelan.4:75
13390 msgid "Frequency & channels"
13393 #. type: Plain text
13394 #: build/C/man4/wavelan.4:86
13396 "For the 2.4GHz 2.00 Hardware, you are able to set the frequency by "
13397 "specifying one of the 10 defined channels (I<2.412,> I<2.422, 2.425, 2.4305, "
13398 "2.432, 2.442, 2.452, 2.460, 2.462> or I<2.484>) or directly by its value. "
13399 "The frequency is changed immediately and permanently. Frequency "
13400 "availability depends on the regulations..."
13404 #: build/C/man4/wavelan.4:86
13406 msgid "Statistics spy"
13409 #. type: Plain text
13410 #: build/C/man4/wavelan.4:90
13412 "Set a list of MAC addresses in the driver (up to 8) and get the last quality "
13413 "of link for each of those (see B<iwspy>(8))."
13417 #: build/C/man4/wavelan.4:90
13419 msgid "/proc/net/wireless"
13422 #. type: Plain text
13423 #: build/C/man4/wavelan.4:105
13425 "I<status> is the status reported by the modem. I<Link quality> reports the "
13426 "quality of the modulation on the air (direct sequence spread spectrum) [max "
13427 "= 16]. I<Level> and I<Noise> refer to the signal level and noise level [max "
13428 "= 64]. The I<crypt discarded packet> and I<misc discarded packet> counters "
13429 "are not implemented."
13433 #: build/C/man4/wavelan.4:105
13435 msgid "Private ioctl"
13438 #. type: Plain text
13439 #: build/C/man4/wavelan.4:109
13440 msgid "You may use B<iwpriv>(8) to manipulate private ioctls."
13444 #: build/C/man4/wavelan.4:109
13446 msgid "Quality and level threshold"
13449 #. type: Plain text
13450 #: build/C/man4/wavelan.4:112
13452 "Enable you the define the quality and level threshold used by the modem "
13453 "(packet below that level are discarded)."
13457 #: build/C/man4/wavelan.4:112
13462 #. type: Plain text
13463 #: build/C/man4/wavelan.4:119
13465 "This functionality makes it possible to set a number of signal level "
13466 "intervals and to count the number of packets received in each of those "
13467 "defined intervals. This distribution might be used to calculate the mean "
13468 "value and standard deviation of the signal level."
13472 #: build/C/man4/wavelan.4:119
13474 msgid "Specific notes"
13477 #. type: Plain text
13478 #: build/C/man4/wavelan.4:125
13480 "This driver will fail to detect some B<non-NCR/ATT&T/Lucent> Wavelan cards. "
13481 "If this happens for you, you must look in the source code on how to add your "
13482 "card to the detection routine."
13486 #. Bruce Janson \(em bruce@cs.usyd.edu.au
13488 #. Jean Tourrilhes \(em jt@hplb.hpl.hp.com
13490 #. (and others; see source code for details)
13493 #. type: Plain text
13494 #: build/C/man4/wavelan.4:138
13496 "Some of the mentioned features are optional. You may enable to disable them "
13497 "by changing flags in the driver header and recompile."
13500 #. type: Plain text
13501 #: build/C/man4/wavelan.4:145
13503 "B<wavelan_cs>(4), B<ifconfig>(8), B<insmod>(8), B<iwconfig>(8), "
13504 "B<iwpriv>(8), B<iwspy>(8)"