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-03-26 16:48+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 build/C/man7/uri.7:48
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:37 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:75 build/C/man4/dsp56k.4:110 build/C/man4/fd.4:194 build/C/man4/full.4:49 build/C/man4/hd.4:95 build/C/man4/hpsa.4:63 build/C/man4/initrd.4:418 build/C/man4/lp.4:114 build/C/man4/mem.4:76 build/C/man4/mouse.4:149 build/C/man4/null.4:46 build/C/man4/ram.4:39 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:45 build/C/man4/vcs.4:81
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:243
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 /proc file-system entry, which the \"block\" side of the driver creates "
466 "as I</proc/driver/cciss/cciss*> at run time. This is because at driver init "
467 "time, the SCSI core may not yet be initialized (because the driver is a "
468 "block driver) and attempting to register it with the SCSI core in such a "
469 "case would cause a hang. This is best done via an initialization script "
470 "(typically in I</etc/init.d>, but could vary depending on distribution). "
475 #: build/C/man4/cciss.4:249
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:253
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:257
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:257
502 msgid "Hot plug support for SCSI tape drives"
506 #: build/C/man4/cciss.4:265
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 /proc file system. For example:"
514 #: build/C/man4/cciss.4:267
516 msgid " echo \"rescan\" E<gt> /proc/scsi/cciss0/1\n"
520 #: build/C/man4/cciss.4:269
521 msgid "This causes the driver to:"
525 #: build/C/man4/cciss.4:270 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:273
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:273 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:276
546 "make note of any new or removed sequential access devices or medium "
551 #: build/C/man4/cciss.4:283
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:288
561 "Note that the naming convention of the /proc file-system entries contains a "
562 "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:306
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:306
583 msgid "SCSI error handling for tape drives and medium changers"
587 #: build/C/man4/cciss.4:314
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:314 build/C/man4/cciss.4:316 build/C/man4/cciss.4:318 build/C/man4/cciss.4:320 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:316
604 msgid "First, the device is told to abort the command."
608 #: build/C/man4/cciss.4:318
609 msgid "If that doesn't work, the device is reset."
613 #: build/C/man4/cciss.4:320
614 msgid "If that doesn't work, the SCSI bus is reset."
618 #: build/C/man4/cciss.4:322
619 msgid "If that doesn't work the host bus adapter is reset."
623 #: build/C/man4/cciss.4:340
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:348
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:348 build/C/man4/console.4:79 build/C/man4/console_codes.4:642 build/C/man4/console_ioctl.4:614 build/C/man5/core.5:406 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:51 build/C/man3/gnu_get_libc_version.3:76 build/C/man4/hd.4:97 build/C/man4/hpsa.4:179 build/C/man4/initrd.4:474 build/C/man4/lp.4:123 build/C/man3/makedev.3:80 build/C/man4/mem.4:82 build/C/man3/mkfifo.3:106 build/C/man2/mknod.2:209 build/C/man4/mouse.4:153 build/C/man4/msr.4:55 build/C/man4/null.4:53 build/C/man7/pipe.7:232 build/C/man4/ram.4:41 build/C/man4/random.4:282 build/C/man3/setlogmask.3:72 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:47 build/C/man7/uri.7:706 build/C/man4/vcs.4:151 build/C/man4/wavelan.4:135
655 #: build/C/man4/cciss.4:353
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:365
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:365 build/C/man4/console.4:96 build/C/man4/console_codes.4:646 build/C/man4/console_ioctl.4:641 build/C/man5/core.5:417 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:55 build/C/man3/gnu_get_libc_version.3:78 build/C/man4/hd.4:102 build/C/man4/hpsa.4:197 build/C/man4/initrd.4:484 build/C/man4/lp.4:129 build/C/man3/makedev.3:83 build/C/man4/mem.4:86 build/C/man3/mkfifo.3:116 build/C/man2/mknod.2:223 build/C/man4/mouse.4:156 build/C/man4/msr.4:59 build/C/man4/null.4:57 build/C/man7/pipe.7:244 build/C/man4/ram.4:45 build/C/man4/random.4:286 build/C/man4/sd.4:137 build/C/man3/setlogmask.3:76 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:54 build/C/man7/uri.7:715 build/C/man4/vcs.4:156 build/C/man4/wavelan.4:142
678 #: build/C/man4/cciss.4:372 build/C/man4/console.4:103 build/C/man4/console_codes.4:653 build/C/man4/console_ioctl.4:648 build/C/man5/core.5:424 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:62 build/C/man3/gnu_get_libc_version.3:85 build/C/man4/hd.4:109 build/C/man4/hpsa.4:204 build/C/man4/initrd.4:491 build/C/man4/lp.4:136 build/C/man3/makedev.3:90 build/C/man4/mem.4:93 build/C/man3/mkfifo.3:123 build/C/man2/mknod.2:230 build/C/man4/mouse.4:163 build/C/man4/msr.4:66 build/C/man4/null.4:64 build/C/man7/pipe.7:251 build/C/man4/ram.4:52 build/C/man4/random.4:293 build/C/man4/sd.4:144 build/C/man3/setlogmask.3:83 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:61 build/C/man7/uri.7:722 build/C/man4/vcs.4:163 build/C/man4/wavelan.4:149
680 "This page is part of release 3.50 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:26
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/tty>I<n> "
707 "with 1 \\(E<lt>= I<n> \\(E<lt>= 63. The current console is also addressed "
708 "by I</dev/console> or I</dev/tty0>, the character device with major number 4 "
709 "and minor number 0. The device files /dev/* are usually created using the "
710 "script MAKEDEV, or using B<mknod>(1), usually with mode 0622 and owner "
715 #: build/C/man4/console.4:32
717 "Before kernel version 1.1.54 the number of virtual consoles was compiled "
718 "into the kernel (in tty.h: #define NR_CONSOLES 8) and could be changed by "
719 "editing and recompiling. Since version 1.1.54 virtual consoles are created "
720 "on the fly, as soon as they are needed."
724 #: build/C/man4/console.4:50
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:61
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:67
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:67
760 #: build/C/man4/console.4:75
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:77
770 msgid "I</dev/console>"
774 #: build/C/man4/console.4:79
779 #: build/C/man4/console.4:96
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 only make 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:592 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:50 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 - ioctl's for console terminal and virtual consoles"
2535 #: build/C/man4/console_ioctl.4:48
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:48
2548 #: build/C/man4/console_ioctl.4:53
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:57
2558 " LED_CAP 0x04 caps lock led\n"
2559 " LEC_NUM 0x02 num lock led\n"
2560 " LED_SCR 0x01 scroll lock led\n"
2564 #: build/C/man4/console_ioctl.4:57
2570 #: build/C/man4/console_ioctl.4:64
2572 "Set the LEDs. The LEDs are set to correspond to the lower three bits of "
2573 "I<argp>. However, if a higher order bit is set, the LEDs revert to normal: "
2574 "displaying the state of the keyboard functions of caps lock, num lock, and "
2579 #: build/C/man4/console_ioctl.4:71
2581 "Before 1.1.54, the LEDs just reflected the state of the corresponding "
2582 "keyboard flags, and KDGETLED/KDSETLED would also change the keyboard flags. "
2583 "Since 1.1.54 the leds can be made to display arbitrary information, but by "
2584 "default they display the keyboard flags. The following two ioctl's are used "
2585 "to access the keyboard flags."
2589 #: build/C/man4/console_ioctl.4:71
2595 #: build/C/man4/console_ioctl.4:78
2597 "Get keyboard flags CapsLock, NumLock, ScrollLock (not lights). I<argp> "
2598 "points to a char which is set to the flag state. The low order three bits "
2599 "(mask 0x7) get the current flag state, and the low order bits of the next "
2600 "nibble (mask 0x70) get the default flag state. (Since 1.1.54.)"
2604 #: build/C/man4/console_ioctl.4:78
2610 #: build/C/man4/console_ioctl.4:85
2612 "Set keyboard flags CapsLock, NumLock, ScrollLock (not lights). I<argp> has "
2613 "the desired flag state. The low order three bits (mask 0x7) have the flag "
2614 "state, and the low order bits of the next nibble (mask 0x70) have the "
2615 "default flag state. (Since 1.1.54.)"
2619 #: build/C/man4/console_ioctl.4:85
2621 msgid "B<KDGKBTYPE>"
2625 #: build/C/man4/console_ioctl.4:88
2626 msgid "Get keyboard type. This returns the value KB_101, defined as 0x02."
2630 #: build/C/man4/console_ioctl.4:88
2636 #: build/C/man4/console_ioctl.4:91
2637 msgid "Add I/O port as valid. Equivalent to I<ioperm(arg,1,1)>."
2641 #: build/C/man4/console_ioctl.4:91
2647 #: build/C/man4/console_ioctl.4:94
2648 msgid "Delete I/O port as valid. Equivalent to I<ioperm(arg,1,0)>."
2652 #: build/C/man4/console_ioctl.4:94
2658 #: build/C/man4/console_ioctl.4:97
2660 "Enable I/O to video board. Equivalent to I<ioperm(0x3b4, 0x3df-0x3b4+1, "
2665 #: build/C/man4/console_ioctl.4:97
2667 msgid "B<KDDISABIO>"
2671 #: build/C/man4/console_ioctl.4:100
2673 "Disable I/O to video board. Equivalent to I<ioperm(0x3b4, 0x3df-0x3b4+1, "
2678 #: build/C/man4/console_ioctl.4:100
2680 msgid "B<KDSETMODE>"
2684 #: build/C/man4/console_ioctl.4:103
2685 msgid "Set text/graphics mode. I<argp> is one of these:"
2689 #: build/C/man4/console_ioctl.4:106
2693 " KD_GRAPHICS 0x01\n"
2697 #: build/C/man4/console_ioctl.4:106
2699 msgid "B<KDGETMODE>"
2703 #: build/C/man4/console_ioctl.4:110
2705 "Get text/graphics mode. I<argp> points to a I<long> which is set to one of "
2710 #: build/C/man4/console_ioctl.4:110
2716 #: build/C/man4/console_ioctl.4:119
2718 "Generate tone of specified length. The lower 16 bits of I<argp> specify the "
2719 "period in clock cycles, and the upper 16 bits give the duration in msec. If "
2720 "the duration is zero, the sound is turned off. Control returns "
2721 "immediately. For example, I<argp> = (125E<lt>E<lt>16) + 0x637 would specify "
2722 "the beep normally associated with a ctrl-G. (Thus since 0.99pl1; broken in "
2727 #: build/C/man4/console_ioctl.4:119
2729 msgid "B<KIOCSOUND>"
2733 #: build/C/man4/console_ioctl.4:126
2735 "Start or stop sound generation. The lower 16 bits of I<argp> specify the "
2736 "period in clock cycles (that is, I<argp> = 1193180/frequency). I<argp> = 0 "
2737 "turns sound off. In either case, control returns immediately."
2741 #: build/C/man4/console_ioctl.4:126
2747 #: build/C/man4/console_ioctl.4:131
2749 "Get the current default color map from kernel. I<argp> points to a 48-byte "
2750 "array. (Since 1.3.3.)"
2754 #: build/C/man4/console_ioctl.4:131
2760 #: build/C/man4/console_ioctl.4:142
2762 "Change the default text-mode color map. I<argp> points to a 48-byte array "
2763 "which contains, in order, the Red, Green, and Blue values for the 16 "
2764 "available screen colors: 0 is off, and 255 is full intensity. The default "
2765 "colors are, in order: black, dark red, dark green, brown, dark blue, dark "
2766 "purple, dark cyan, light grey, dark grey, bright red, bright green, yellow, "
2767 "bright blue, bright purple, bright cyan and white. (Since 1.3.3.)"
2771 #: build/C/man4/console_ioctl.4:142
2777 #: build/C/man4/console_ioctl.4:148
2779 "Gets 256-character screen font in expanded form. I<argp> points to an 8192 "
2780 "byte array. Fails with error code B<EINVAL> if the currently loaded font is "
2781 "a 512-character font, or if the console is not in text mode."
2785 #: build/C/man4/console_ioctl.4:148
2787 msgid "B<GIO_FONTX>"
2791 #: build/C/man4/console_ioctl.4:161
2793 "Gets screen font and associated information. I<argp> points to a I<struct "
2794 "consolefontdesc> (see B<PIO_FONTX>). On call, the I<charcount> field should "
2795 "be set to the maximum number of characters that would fit in the buffer "
2796 "pointed to by I<chardata>. On return, the I<charcount> and I<charheight> "
2797 "are filled with the respective data for the currently loaded font, and the "
2798 "I<chardata> array contains the font data if the initial value of "
2799 "I<charcount> indicated enough space was available; otherwise the buffer is "
2800 "untouched and I<errno> is set to B<ENOMEM>. (Since 1.3.1.)"
2804 #: build/C/man4/console_ioctl.4:161
2810 #: build/C/man4/console_ioctl.4:170
2812 "Sets 256-character screen font. Load font into the EGA/VGA character "
2813 "generator. I<argp> points to a 8192 byte map, with 32 bytes per character. "
2814 "Only first I<N> of them are used for an 8xI<N> font (0 E<lt> I<N> E<lt>= "
2815 "32). This call also invalidates the Unicode mapping."
2819 #: build/C/man4/console_ioctl.4:170
2821 msgid "B<PIO_FONTX>"
2825 #: build/C/man4/console_ioctl.4:174
2826 msgid "Sets screen font and associated rendering information. I<argp> points to a"
2830 #: build/C/man4/console_ioctl.4:185
2833 "struct consolefontdesc {\n"
2834 " unsigned short charcount; /* characters in font\n"
2835 " (256 or 512) */\n"
2836 " unsigned short charheight; /* scan lines per\n"
2837 " character (1-32) */\n"
2838 " char *chardata; /* font data in\n"
2839 " expanded form */\n"
2844 #: build/C/man4/console_ioctl.4:192
2846 "If necessary, the screen will be appropriately resized, and B<SIGWINCH> sent "
2847 "to the appropriate processes. This call also invalidates the Unicode "
2848 "mapping. (Since 1.3.1.)"
2852 #: build/C/man4/console_ioctl.4:192
2854 msgid "B<PIO_FONTRESET>"
2858 #: build/C/man4/console_ioctl.4:198
2860 "Resets the screen font, size and Unicode mapping to the bootup defaults. "
2861 "I<argp> is unused, but should be set to NULL to ensure compatibility with "
2862 "future versions of Linux. (Since 1.3.28.)"
2866 #: build/C/man4/console_ioctl.4:198
2868 msgid "B<GIO_SCRNMAP>"
2872 #: build/C/man4/console_ioctl.4:205
2874 "Get screen mapping from kernel. I<argp> points to an area of size E_TABSZ, "
2875 "which is loaded with the font positions used to display each character. "
2876 "This call is likely to return useless information if the currently loaded "
2877 "font is more than 256 characters."
2881 #: build/C/man4/console_ioctl.4:205
2883 msgid "B<GIO_UNISCRNMAP>"
2887 #: build/C/man4/console_ioctl.4:213
2889 "Get full Unicode screen mapping from kernel. I<argp> points to an area of "
2890 "size E_TABSZ*sizeof(unsigned short), which is loaded with the Unicodes each "
2891 "character represent. A special set of Unicodes, starting at U+F000, are "
2892 "used to represent \"direct to font\" mappings. (Since 1.3.1.)"
2896 #: build/C/man4/console_ioctl.4:213
2898 msgid "B<PIO_SCRNMAP>"
2902 #: build/C/man4/console_ioctl.4:218
2904 "Loads the \"user definable\" (fourth) table in the kernel which maps bytes "
2905 "into console screen symbols. I<argp> points to an area of size E_TABSZ."
2909 #: build/C/man4/console_ioctl.4:218
2911 msgid "B<PIO_UNISCRNMAP>"
2915 #: build/C/man4/console_ioctl.4:225
2917 "Loads the \"user definable\" (fourth) table in the kernel which maps bytes "
2918 "into Unicodes, which are then translated into screen symbols according to "
2919 "the currently loaded Unicode-to-font map. Special Unicodes starting at "
2920 "U+F000 can be used to map directly to the font symbols. (Since 1.3.1.)"
2924 #: build/C/man4/console_ioctl.4:225
2926 msgid "B<GIO_UNIMAP>"
2930 #: build/C/man4/console_ioctl.4:228
2931 msgid "Get Unicode-to-font mapping from kernel. I<argp> points to a"
2935 #: build/C/man4/console_ioctl.4:235
2938 "struct unimapdesc {\n"
2939 " unsigned short entry_ct;\n"
2940 " struct unipair *entries;\n"
2945 #: build/C/man4/console_ioctl.4:239
2946 msgid "where I<entries> points to an array of"
2950 #: build/C/man4/console_ioctl.4:246
2953 "struct unipair {\n"
2954 " unsigned short unicode;\n"
2955 " unsigned short fontpos;\n"
2960 #: build/C/man4/console_ioctl.4:250 build/C/man4/console_ioctl.4:270
2961 msgid "(Since 1.1.92.)"
2965 #: build/C/man4/console_ioctl.4:250
2967 msgid "B<PIO_UNIMAP>"
2971 #: build/C/man4/console_ioctl.4:255
2974 "Put unicode-to-font mapping in kernel.\n"
2975 " I<argp> points to a\n"
2976 "I<struct unimapdesc>.\n"
2981 #: build/C/man4/console_ioctl.4:255
2983 msgid "B<PIO_UNIMAPCLR>"
2987 #: build/C/man4/console_ioctl.4:258
2988 msgid "Clear table, possibly advise hash algorithm. I<argp> points to a"
2992 #: build/C/man4/console_ioctl.4:266
2995 "struct unimapinit {\n"
2996 " unsigned short advised_hashsize; /* 0 if no opinion */\n"
2997 " unsigned short advised_hashstep; /* 0 if no opinion */\n"
2998 " unsigned short advised_hashlevel; /* 0 if no opinion */\n"
3003 #: build/C/man4/console_ioctl.4:270
3005 msgid "B<KDGKBMODE>"
3009 #: build/C/man4/console_ioctl.4:274
3011 "Gets current keyboard mode. I<argp> points to a I<long> which is set to one "
3016 #: build/C/man4/console_ioctl.4:279
3021 " K_MEDIUMRAW 0x02\n"
3026 #: build/C/man4/console_ioctl.4:279
3028 msgid "B<KDSKBMODE>"
3032 #: build/C/man4/console_ioctl.4:282
3034 "Sets current keyboard mode. I<argp> is a I<long> equal to one of the above "
3039 #: build/C/man4/console_ioctl.4:282
3041 msgid "B<KDGKBMETA>"
3045 #: build/C/man4/console_ioctl.4:286
3047 "Gets meta key handling mode. I<argp> points to a I<long> which is set to "
3052 #: build/C/man4/console_ioctl.4:289
3055 " K_METABIT 0x03 set high order bit\n"
3056 " K_ESCPREFIX 0x04 escape prefix\n"
3060 #: build/C/man4/console_ioctl.4:289
3062 msgid "B<KDSKBMETA>"
3066 #: build/C/man4/console_ioctl.4:292
3068 "Sets meta key handling mode. I<argp> is a I<long> equal to one of the above "
3073 #: build/C/man4/console_ioctl.4:292
3079 #: build/C/man4/console_ioctl.4:295
3081 "Gets one entry in key translation table (keycode to action code). I<argp> "
3086 #: build/C/man4/console_ioctl.4:303
3089 "struct kbentry {\n"
3090 " unsigned char kb_table;\n"
3091 " unsigned char kb_index;\n"
3092 " unsigned short kb_value;\n"
3097 #: build/C/man4/console_ioctl.4:312
3099 "with the first two members filled in: I<kb_table> selects the key table (0 "
3100 "E<lt>= I<kb_table> E<lt> MAX_NR_KEYMAPS), and I<kb_index> is the keycode (0 "
3101 "E<lt>= I<kb_index> E<lt> NR_KEYS). I<kb_value> is set to the corresponding "
3102 "action code, or K_HOLE if there is no such key, or K_NOSUCHMAP if "
3103 "I<kb_table> is invalid."
3107 #: build/C/man4/console_ioctl.4:312
3113 #: build/C/man4/console_ioctl.4:316
3114 msgid "Sets one entry in translation table. I<argp> points to a I<struct kbentry>."
3118 #: build/C/man4/console_ioctl.4:316
3120 msgid "B<KDGKBSENT>"
3124 #: build/C/man4/console_ioctl.4:319
3125 msgid "Gets one function key string. I<argp> points to a"
3129 #: build/C/man4/console_ioctl.4:326
3132 "struct kbsentry {\n"
3133 " unsigned char kb_func;\n"
3134 " unsigned char kb_string[512];\n"
3139 #: build/C/man4/console_ioctl.4:331
3141 "I<kb_string> is set to the (null-terminated) string corresponding to the "
3142 "I<kb_func>th function key action code."
3146 #: build/C/man4/console_ioctl.4:331
3148 msgid "B<KDSKBSENT>"
3152 #: build/C/man4/console_ioctl.4:335
3153 msgid "Sets one function key string entry. I<argp> points to a I<struct kbsentry>."
3157 #: build/C/man4/console_ioctl.4:335
3159 msgid "B<KDGKBDIACR>"
3163 #: build/C/man4/console_ioctl.4:338
3164 msgid "Read kernel accent table. I<argp> points to a"
3168 #: build/C/man4/console_ioctl.4:345
3171 "struct kbdiacrs {\n"
3172 " unsigned int kb_cnt;\n"
3173 " struct kbdiacr kbdiacr[256];\n"
3178 #: build/C/man4/console_ioctl.4:350
3179 msgid "where I<kb_cnt> is the number of entries in the array, each of which is a"
3183 #: build/C/man4/console_ioctl.4:358
3186 "struct kbdiacr {\n"
3187 " unsigned char diacr;\n"
3188 " unsigned char base;\n"
3189 " unsigned char result;\n"
3194 #: build/C/man4/console_ioctl.4:360
3196 msgid "B<KDGETKEYCODE>"
3200 #: build/C/man4/console_ioctl.4:363
3201 msgid "Read kernel keycode table entry (scan code to keycode). I<argp> points to a"
3205 #: build/C/man4/console_ioctl.4:370
3208 "struct kbkeycode {\n"
3209 " unsigned int scancode;\n"
3210 " unsigned int keycode;\n"
3215 #: build/C/man4/console_ioctl.4:377
3217 "I<keycode> is set to correspond to the given I<scancode>. (89 E<lt>= "
3218 "I<scancode> E<lt>= 255 only. For 1 E<lt>= I<scancode> E<lt>= 88, "
3219 "I<keycode>==I<scancode>.) (Since 1.1.63.)"
3223 #: build/C/man4/console_ioctl.4:377
3225 msgid "B<KDSETKEYCODE>"
3229 #: build/C/man4/console_ioctl.4:382
3231 "Write kernel keycode table entry. I<argp> points to a I<struct kbkeycode>. "
3236 #: build/C/man4/console_ioctl.4:382
3238 msgid "B<KDSIGACCEPT>"
3242 #: build/C/man4/console_ioctl.4:387
3244 "The calling process indicates its willingness to accept the signal I<argp> "
3245 "when it is generated by pressing an appropriate key combination. (1 E<lt>= "
3246 "I<argp> E<lt>= NSIG). (See spawn_console() in "
3247 "linux/drivers/char/keyboard.c.)"
3251 #: build/C/man4/console_ioctl.4:387
3253 msgid "B<VT_OPENQRY>"
3257 #: build/C/man4/console_ioctl.4:391
3259 "Returns the first available (non-opened) console. I<argp> points to an "
3260 "I<int> which is set to the number of the vt (1 E<lt>= I<*argp> E<lt>= "
3265 #: build/C/man4/console_ioctl.4:391
3267 msgid "B<VT_GETMODE>"
3271 #: build/C/man4/console_ioctl.4:394
3272 msgid "Get mode of active vt. I<argp> points to a"
3276 #: build/C/man4/console_ioctl.4:404
3279 "struct vt_mode {\n"
3280 " char mode; /* vt mode */\n"
3281 " char waitv; /* if set, hang on writes if not active */\n"
3282 " short relsig; /* signal to raise on release req */\n"
3283 " short acqsig; /* signal to raise on acquisition */\n"
3284 " short frsig; /* unused (set to 0) */\n"
3289 #: build/C/man4/console_ioctl.4:409
3291 "which is set to the mode of the active vt. I<mode> is set to one of these "
3296 #: build/C/man4/console_ioctl.4:413
3299 " VT_AUTO auto vt switching\n"
3300 " VT_PROCESS process controls switching\n"
3301 " VT_ACKACQ acknowledge switch\n"
3305 #: build/C/man4/console_ioctl.4:413
3307 msgid "B<VT_SETMODE>"
3311 #: build/C/man4/console_ioctl.4:417
3312 msgid "Set mode of active vt. I<argp> points to a I<struct vt_mode>."
3316 #: build/C/man4/console_ioctl.4:417
3318 msgid "B<VT_GETSTATE>"
3322 #: build/C/man4/console_ioctl.4:420
3323 msgid "Get global vt state info. I<argp> points to a"
3327 #: build/C/man4/console_ioctl.4:428
3330 "struct vt_stat {\n"
3331 " unsigned short v_active; /* active vt */\n"
3332 " unsigned short v_signal; /* signal to send */\n"
3333 " unsigned short v_state; /* vt bit mask */\n"
3338 #: build/C/man4/console_ioctl.4:433
3340 "For each vt in use, the corresponding bit in the I<v_state> member is set. "
3341 "(Kernels 1.0 through 1.1.92.)"
3345 #: build/C/man4/console_ioctl.4:433
3347 msgid "B<VT_RELDISP>"
3351 #: build/C/man4/console_ioctl.4:435
3352 msgid "Release a display."
3356 #: build/C/man4/console_ioctl.4:435
3358 msgid "B<VT_ACTIVATE>"
3362 #: build/C/man4/console_ioctl.4:437
3363 msgid "Switch to vt I<argp> (1 E<lt>= I<argp> E<lt>= MAX_NR_CONSOLES)."
3367 #: build/C/man4/console_ioctl.4:437
3369 msgid "B<VT_WAITACTIVE>"
3373 #: build/C/man4/console_ioctl.4:439
3374 msgid "Wait until vt I<argp> has been activated."
3378 #: build/C/man4/console_ioctl.4:439
3380 msgid "B<VT_DISALLOCATE>"
3384 #: build/C/man4/console_ioctl.4:442
3385 msgid "Deallocate the memory associated with vt I<argp>. (Since 1.1.54.)"
3389 #: build/C/man4/console_ioctl.4:442
3391 msgid "B<VT_RESIZE>"
3395 #: build/C/man4/console_ioctl.4:445
3396 msgid "Set the kernel's idea of screensize. I<argp> points to a"
3400 #: build/C/man4/console_ioctl.4:453
3403 "struct vt_sizes {\n"
3404 " unsigned short v_rows; /* # rows */\n"
3405 " unsigned short v_cols; /* # columns */\n"
3406 " unsigned short v_scrollsize; /* no longer used */\n"
3411 #: build/C/man4/console_ioctl.4:460
3413 "Note that this does not change the videomode. See B<resizecons>(8). (Since "
3418 #: build/C/man4/console_ioctl.4:460
3420 msgid "B<VT_RESIZEX>"
3424 #: build/C/man4/console_ioctl.4:463
3425 msgid "Set the kernel's idea of various screen parameters. I<argp> points to a"
3429 #: build/C/man4/console_ioctl.4:478
3432 "struct vt_consize {\n"
3433 " unsigned short v_rows; /* number of rows */\n"
3434 " unsigned short v_cols; /* number of columns */\n"
3435 " unsigned short v_vlin; /* number of pixel rows\n"
3437 " unsigned short v_clin; /* number of pixel rows\n"
3438 " per character */\n"
3439 " unsigned short v_vcol; /* number of pixel columns\n"
3441 " unsigned short v_ccol; /* number of pixel columns\n"
3442 " per character */\n"
3447 #: build/C/man4/console_ioctl.4:487
3449 "Any parameter may be set to zero, indicating \"no change\", but if multiple "
3450 "parameters are set, they must be self-consistent. Note that this does not "
3451 "change the videomode. See B<resizecons>(8). (Since 1.3.3.)"
3455 #: build/C/man4/console_ioctl.4:491
3457 "The action of the following ioctls depends on the first byte in the struct "
3458 "pointed to by I<argp>, referred to here as the I<subcode>. These are legal "
3459 "only for the superuser or the owner of the current terminal."
3463 #: build/C/man4/console_ioctl.4:491
3465 msgid "B<TIOCLINUX, subcode=0>"
3469 #: build/C/man4/console_ioctl.4:495
3471 "Dump the screen. Disappeared in 1.1.92. (With kernel 1.1.92 or later, read "
3472 "from /dev/vcsN or /dev/vcsaN instead.)"
3476 #: build/C/man4/console_ioctl.4:495
3478 msgid "B<TIOCLINUX, subcode=1>"
3482 #: build/C/man4/console_ioctl.4:498
3483 msgid "Get task information. Disappeared in 1.1.92."
3487 #: build/C/man4/console_ioctl.4:498
3489 msgid "B<TIOCLINUX, subcode=2>"
3493 #: build/C/man4/console_ioctl.4:501
3494 msgid "Set selection. I<argp> points to a"
3498 #: build/C/man4/console_ioctl.4:509
3503 " short xs, ys, xe, ye;\n"
3504 " short sel_mode;\n"
3509 #: build/C/man4/console_ioctl.4:521
3511 "I<xs> and I<ys> are the starting column and row. I<xe> and I<ye> are the "
3512 "ending column and row. (Upper left corner is row=column=1.) I<sel_mode> is "
3513 "0 for character-by-character selection, 1 for word-by-word selection, or 2 "
3514 "for line-by-line selection. The indicated screen characters are highlighted "
3515 "and saved in the static array sel_buffer in devices/char/console.c."
3519 #: build/C/man4/console_ioctl.4:521
3521 msgid "B<TIOCLINUX, subcode=3>"
3525 #: build/C/man4/console_ioctl.4:525
3527 "Paste selection. The characters in the selection buffer are written to "
3532 #: build/C/man4/console_ioctl.4:525
3534 msgid "B<TIOCLINUX, subcode=4>"
3538 #: build/C/man4/console_ioctl.4:527
3539 msgid "Unblank the screen."
3543 #: build/C/man4/console_ioctl.4:527
3545 msgid "B<TIOCLINUX, subcode=5>"
3549 #: build/C/man4/console_ioctl.4:531
3551 "Sets contents of a 256-bit look up table defining characters in a \"word\", "
3552 "for word-by-word selection. (Since 1.1.32.)"
3556 #: build/C/man4/console_ioctl.4:531
3558 msgid "B<TIOCLINUX, subcode=6>"
3562 #: build/C/man4/console_ioctl.4:535
3564 "I<argp> points to a char which is set to the value of the kernel variable "
3565 "I<shift_state>. (Since 1.1.32.)"
3569 #: build/C/man4/console_ioctl.4:535
3571 msgid "B<TIOCLINUX, subcode=7>"
3575 #: build/C/man4/console_ioctl.4:539
3577 "I<argp> points to a char which is set to the value of the kernel variable "
3578 "I<report_mouse>. (Since 1.1.33.)"
3582 #: build/C/man4/console_ioctl.4:539
3584 msgid "B<TIOCLINUX, subcode=8>"
3588 #: build/C/man4/console_ioctl.4:544
3590 "Dump screen width and height, cursor position, and all the "
3591 "character-attribute pairs. (Kernels 1.1.67 through 1.1.91 only. With "
3592 "kernel 1.1.92 or later, read from /dev/vcsa* instead.)"
3596 #: build/C/man4/console_ioctl.4:544
3598 msgid "B<TIOCLINUX, subcode=9>"
3602 #: build/C/man4/console_ioctl.4:549
3604 "Restore screen width and height, cursor position, and all the "
3605 "character-attribute pairs. (Kernels 1.1.67 through 1.1.91 only. With "
3606 "kernel 1.1.92 or later, write to /dev/vcsa* instead.)"
3610 #: build/C/man4/console_ioctl.4:549
3612 msgid "B<TIOCLINUX, subcode=10>"
3616 #: build/C/man4/console_ioctl.4:554
3618 "Handles the Power Saving feature of the new generation of monitors. VESA "
3619 "screen blanking mode is set to I<argp>[1], which governs what screen "
3624 #: build/C/man4/console_ioctl.4:556
3626 msgid " I<0>: Screen blanking is disabled.\n"
3630 #: build/C/man4/console_ioctl.4:563
3633 " I<1>: The current video adapter\n"
3634 "register settings are saved, then the controller is programmed to turn off\n"
3635 "the vertical synchronization pulses.\n"
3636 "This puts the monitor into \"standby\" mode.\n"
3637 "If your monitor has an Off_Mode timer, then\n"
3638 "it will eventually power down by itself.\n"
3642 #: build/C/man4/console_ioctl.4:572
3645 " I<2>: The current\n"
3646 "settings are saved, then both the vertical and horizontal\n"
3647 "synchronization pulses are turned off.\n"
3648 "This puts the monitor into \"off\" mode.\n"
3649 "If your monitor has no Off_Mode timer,\n"
3650 "or if you want your monitor to power down immediately when the\n"
3651 "blank_timer times out, then you choose this option.\n"
3652 "(I<Caution:> Powering down frequently will damage the monitor.)\n"
3656 #: build/C/man4/console_ioctl.4:574
3657 msgid "(Since 1.1.76.)"
3661 #: build/C/man4/console_ioctl.4:574 build/C/man3/mkfifo.3:61 build/C/man2/mknod.2:101 build/C/man3/setlogmask.3:63 build/C/man4/st.4:827 build/C/man2/syslog.2:244
3663 msgid "RETURN VALUE"
3667 #: build/C/man4/console_ioctl.4:577
3668 msgid "On success, 0 is returned. On error -1 is returned, and I<errno> is set."
3672 #: build/C/man4/console_ioctl.4:577 build/C/man3/mkfifo.3:67 build/C/man2/mknod.2:106 build/C/man3/setlogmask.3:65 build/C/man2/syslog.2:260
3678 #: build/C/man4/console_ioctl.4:579
3679 msgid "I<errno> may take on these values:"
3683 #: build/C/man4/console_ioctl.4:579
3689 #: build/C/man4/console_ioctl.4:582
3690 msgid "The file descriptor is invalid."
3694 #: build/C/man4/console_ioctl.4:582
3700 #: build/C/man4/console_ioctl.4:586
3702 "The file descriptor is not associated with a character special device, or "
3703 "the specified request does not apply to it."
3707 #: build/C/man4/console_ioctl.4:586 build/C/man2/mknod.2:129 build/C/man4/st.4:842 build/C/man2/syslog.2:261
3713 #: build/C/man4/console_ioctl.4:589
3714 msgid "The file descriptor or I<argp> is invalid."
3718 #: build/C/man4/console_ioctl.4:589 build/C/man2/mknod.2:159 build/C/man2/syslog.2:285
3724 #: build/C/man4/console_ioctl.4:592
3725 msgid "Insufficient permission."
3729 #: build/C/man4/console_ioctl.4:603
3731 "B<Warning>: Do not regard this man page as documentation of the Linux "
3732 "console ioctl's. This is provided for the curious only, as an alternative "
3733 "to reading the source. Ioctl's are undocumented Linux internals, liable to "
3734 "be changed without warning. (And indeed, this page more or less describes "
3735 "the situation as of kernel version 1.1.94; there are many minor and "
3736 "not-so-minor differences with earlier versions.)"
3740 #: build/C/man4/console_ioctl.4:608
3742 "Very often, ioctl's are introduced for communication between the kernel and "
3743 "one particular well-known program (fdisk, hdparm, setserial, tunelp, "
3744 "loadkeys, selection, setfont, etc.), and their behavior will be changed when "
3745 "required by this particular program."
3749 #: build/C/man4/console_ioctl.4:612
3751 "Programs using these ioctl's will not be portable to other versions of UNIX, "
3752 "will not work on older versions of Linux, and will not work on future "
3753 "versions of Linux."
3757 #: build/C/man4/console_ioctl.4:614
3758 msgid "Use POSIX functions."
3762 #: build/C/man4/console_ioctl.4:638
3764 "B<dumpkeys>(1), B<kbd_mode>(1), B<loadkeys>(1), B<mknod>(1), B<setleds>(1), "
3765 "B<setmetamode>(1), B<execve>(2), B<fcntl>(2), B<ioperm>(2), B<termios>(3), "
3766 "B<console>(4), B<console_codes>(4), B<mt>(4), B<sd>(4), B<tty>(4), "
3767 "B<tty_ioctl>(4), B<ttyS>(4), B<vcs>(4), B<vcsa>(4), B<charsets>(7), "
3768 "B<mapscrn>(8), B<resizecons>(8), B<setfont>(8)"
3772 #: build/C/man4/console_ioctl.4:641
3773 msgid "I</usr/include/linux/kd.h>, I</usr/include/linux/vt.h>"
3777 #: build/C/man5/core.5:25
3783 #: build/C/man5/core.5:25
3789 #: build/C/man5/core.5:28
3790 msgid "core - core dump file"
3794 #: build/C/man5/core.5:39
3796 "The default action of certain signals is to cause a process to terminate and "
3797 "produce a I<core dump file>, a disk file containing an image of the "
3798 "process's memory at the time of termination. This image can be used in a "
3799 "debugger (e.g., B<gdb>(1)) to inspect the state of the program at the time "
3800 "that it terminated. A list of the signals which cause a process to dump "
3801 "core can be found in B<signal>(7)."
3805 #: build/C/man5/core.5:46
3807 "A process can set its soft B<RLIMIT_CORE> resource limit to place an upper "
3808 "limit on the size of the core dump file that will be produced if it receives "
3809 "a \"core dump\" signal; see B<getrlimit>(2) for details."
3813 #: build/C/man5/core.5:49
3814 msgid "There are various circumstances in which a core dump file is not produced:"
3818 #: build/C/man5/core.5:61
3820 "The process does not have permission to write the core file. (By default "
3821 "the core file is called I<core>, and is created in the current working "
3822 "directory. See below for details on naming.) Writing the core file will "
3823 "fail if the directory in which it is to be created is nonwritable, or if a "
3824 "file with the same name exists and is not writable or is not a regular file "
3825 "(e.g., it is a directory or a symbolic link)."
3829 #: build/C/man5/core.5:65
3831 "A (writable, regular) file with the same name as would be used for the core "
3832 "dump already exists, but there is more than one hard link to that file."
3836 #: build/C/man5/core.5:69
3838 "The file system where the core dump file would be created is full; or has "
3839 "run out of inodes; or is mounted read-only; or the user has reached their "
3840 "quota for the file system."
3844 #: build/C/man5/core.5:72
3845 msgid "The directory in which the core dump file is to be created does not exist."
3849 #: build/C/man5/core.5:85
3851 "The B<RLIMIT_CORE> (core file size) or B<RLIMIT_FSIZE> (file size) resource "
3852 "limits for the process are set to zero; see B<getrlimit>(2) and the "
3853 "documentation of the shell's I<ulimit> command (I<limit> in B<csh>(1))."
3857 #: build/C/man5/core.5:88
3859 "The binary being executed by the process does not have read permission "
3863 #. FIXME . Perhaps relocate discussion of /proc/sys/fs/suid_dumpable
3864 #. and PR_SET_DUMPABLE to this page?
3866 #: build/C/man5/core.5:101
3868 "The process is executing a set-user-ID (set-group-ID) program that is owned "
3869 "by a user (group) other than the real user (group) ID of the process. "
3870 "(However, see the description of the B<prctl>(2) B<PR_SET_DUMPABLE> "
3871 "operation, and the description of the I</proc/sys/fs/suid_dumpable> file in "
3875 #. commit 046d662f481830e652ac34cd112249adde16452a
3877 #: build/C/man5/core.5:107
3879 "(Since Linux 3.7) The kernel was configured without the B<CONFIG_COREDUMP> "
3884 #: build/C/man5/core.5:113
3886 "In addition, a core dump may exclude part of the address space of the "
3887 "process if the B<madvise>(2) B<MADV_DONTDUMP> flag was employed."
3891 #: build/C/man5/core.5:113
3893 msgid "Naming of core dump files"
3897 #: build/C/man5/core.5:122
3899 "By default, a core dump file is named I<core>, but the "
3900 "I</proc/sys/kernel/core_pattern> file (since Linux 2.6 and 2.4.21) can be "
3901 "set to define a template that is used to name core dump files. The template "
3902 "can contain % specifiers which are substituted by the following values when "
3903 "a core file is created:"
3907 #: build/C/man5/core.5:125
3913 #: build/C/man5/core.5:128
3914 msgid "a single % character"
3918 #: build/C/man5/core.5:128
3924 #: build/C/man5/core.5:131
3925 msgid "PID of dumped process"
3929 #: build/C/man5/core.5:131
3935 #: build/C/man5/core.5:134
3936 msgid "(numeric) real UID of dumped process"
3940 #: build/C/man5/core.5:134
3946 #: build/C/man5/core.5:137
3947 msgid "(numeric) real GID of dumped process"
3951 #: build/C/man5/core.5:137
3957 #: build/C/man5/core.5:140
3958 msgid "number of signal causing dump"
3962 #: build/C/man5/core.5:140
3968 #: build/C/man5/core.5:144
3970 "time of dump, expressed as seconds since the Epoch, 1970-01-01 00:00:00 "
3975 #: build/C/man5/core.5:144
3981 #: build/C/man5/core.5:147
3982 msgid "hostname (same as I<nodename> returned by B<uname>(2))"
3986 #: build/C/man5/core.5:147
3992 #: build/C/man5/core.5:150
3993 msgid "executable filename (without path prefix)"
3997 #: build/C/man5/core.5:150
4003 #: build/C/man5/core.5:154
4005 "pathname of executable, with slashes (\\(aq/\\(aq) replaced by exclamation "
4006 "marks (\\(aq!\\(aq)."
4010 #: build/C/man5/core.5:154
4016 #: build/C/man5/core.5:157
4017 msgid "core file size soft resource limit of crashing process (since Linux 2.6.24)"
4021 #: build/C/man5/core.5:176
4023 "A single % at the end of the template is dropped from the core filename, as "
4024 "is the combination of a % followed by any character other than those listed "
4025 "above. All other characters in the template become a literal part of the "
4026 "core filename. The template may include \\(aq/\\(aq characters, which are "
4027 "interpreted as delimiters for directory names. The maximum size of the "
4028 "resulting core filename is 128 bytes (64 bytes in kernels before 2.6.19). "
4029 "The default value in this file is \"core\". For backward compatibility, if "
4030 "I</proc/sys/kernel/core_pattern> does not include \"%p\" and "
4031 "I</proc/sys/kernel/core_uses_pid> (see below) is nonzero, then .PID will be "
4032 "appended to the core filename."
4036 #: build/C/man5/core.5:187
4038 "Since version 2.4, Linux has also provided a more primitive method of "
4039 "controlling the name of the core dump file. If the "
4040 "I</proc/sys/kernel/core_uses_pid> file contains the value 0, then a core "
4041 "dump file is simply named I<core>. If this file contains a nonzero value, "
4042 "then the core dump file includes the process ID in a name of the form "
4046 #. 9520628e8ceb69fa9a4aee6b57f22675d9e1b709
4048 #: build/C/man5/core.5:194
4050 "Since Linux 3.6, if I</proc/sys/fs/suid_dumpable> is set to 2 "
4051 "(\"suidsafe\"), the pattern must be either an absolute pathname (starting "
4052 "with a leading \\(aq/\\(aq character) or a pipe, as defined below."
4056 #: build/C/man5/core.5:194
4058 msgid "Piping core dumps to a program"
4062 #: build/C/man5/core.5:204
4064 "Since kernel 2.6.19, Linux supports an alternate syntax for the "
4065 "I</proc/sys/kernel/core_pattern> file. If the first character of this file "
4066 "is a pipe symbol (B<|>), then the remainder of the line is interpreted as a "
4067 "program to be executed. Instead of being written to a disk file, the core "
4068 "dump is given as standard input to the program. Note the following points:"
4072 #: build/C/man5/core.5:208
4074 "The program must be specified using an absolute pathname (or a pathname "
4075 "relative to the root directory, I</>), and must immediately follow the '|' "
4080 #: build/C/man5/core.5:211
4081 msgid "The process created to run the program runs as user and group I<root>."
4085 #: build/C/man5/core.5:215
4087 "Command-line arguments can be supplied to the program (since kernel 2.6.24), "
4088 "delimited by white space (up to a total line length of 128 bytes)."
4092 #: build/C/man5/core.5:221
4094 "The command-line arguments can include any of the % specifiers listed "
4095 "above. For example, to pass the PID of the process that is being dumped, "
4096 "specify I<%p> in an argument."
4100 #: build/C/man5/core.5:221
4102 msgid "Controlling which mappings are written to the core dump"
4106 #: build/C/man5/core.5:227
4108 "Since kernel 2.6.23, the Linux-specific I</proc/PID/coredump_filter> file "
4109 "can be used to control which memory segments are written to the core dump "
4110 "file in the event that a core dump is performed for the process with the "
4111 "corresponding process ID."
4115 #: build/C/man5/core.5:233
4117 "The value in the file is a bit mask of memory mapping types (see "
4118 "B<mmap>(2)). If a bit is set in the mask, then memory mappings of the "
4119 "corresponding type are dumped; otherwise they are not dumped. The bits in "
4120 "this file have the following meanings:"
4124 #: build/C/man5/core.5:236
4130 #: build/C/man5/core.5:239
4131 msgid "Dump anonymous private mappings."
4135 #: build/C/man5/core.5:239
4141 #: build/C/man5/core.5:242
4142 msgid "Dump anonymous shared mappings."
4146 #: build/C/man5/core.5:242
4152 #: build/C/man5/core.5:245
4153 msgid "Dump file-backed private mappings."
4157 #: build/C/man5/core.5:245
4162 #. file-backed shared mappings of course also update the underlying
4165 #: build/C/man5/core.5:250
4166 msgid "Dump file-backed shared mappings."
4170 #: build/C/man5/core.5:250
4172 msgid "bit 4 (since Linux 2.6.24)"
4176 #: build/C/man5/core.5:253
4177 msgid "Dump ELF headers."
4181 #: build/C/man5/core.5:253
4183 msgid "bit 5 (since Linux 2.6.28)"
4187 #: build/C/man5/core.5:256
4188 msgid "Dump private huge pages."
4192 #: build/C/man5/core.5:256
4194 msgid "bit 6 (since Linux 2.6.28)"
4198 #: build/C/man5/core.5:259
4199 msgid "Dump shared huge pages."
4203 #: build/C/man5/core.5:267
4205 "By default, the following bits are set: 0, 1, 4 (if the "
4206 "B<CONFIG_CORE_DUMP_DEFAULT_ELF_HEADERS> kernel configuration option is "
4207 "enabled), and 5. The value of this file is displayed in hexadecimal. (The "
4208 "default value is thus displayed as 33.)"
4212 #: build/C/man5/core.5:272
4214 "Memory-mapped I/O pages such as frame buffer are never dumped, and virtual "
4215 "DSO pages are always dumped, regardless of the I<coredump_filter> value."
4219 #: build/C/man5/core.5:282
4221 "A child process created via B<fork>(2) inherits its parent's "
4222 "I<coredump_filter> value; the I<coredump_filter> value is preserved across "
4227 #: build/C/man5/core.5:286
4229 "It can be useful to set I<coredump_filter> in the parent shell before "
4230 "running a program, for example:"
4234 #: build/C/man5/core.5:291
4237 "$B< echo 0x7 E<gt> /proc/self/coredump_filter>\n"
4238 "$B< ./some_program>\n"
4242 #: build/C/man5/core.5:297
4244 "This file is only provided if the kernel was built with the "
4245 "B<CONFIG_ELF_CORE> configuration option."
4249 #: build/C/man5/core.5:302
4251 "The B<gdb>(1) I<gcore> command can be used to obtain a core dump of a "
4255 #. Always including the PID in the name of the core file made
4256 #. sense for LinuxThreads, where each thread had a unique PID,
4257 #. but doesn't seem to serve any purpose with NPTL, where all the
4258 #. threads in a process share the same PID (as POSIX.1 requires).
4259 #. Probably the behavior is maintained so that applications using
4260 #. LinuxThreads continue appending the PID (the kernel has no easy
4261 #. way of telling which threading implementation the user-space
4262 #. application is using). -- mtk, April 2006
4264 #: build/C/man5/core.5:322
4266 "If a multithreaded process (or, more precisely, a process that shares its "
4267 "memory with another process by being created with the B<CLONE_VM> flag of "
4268 "B<clone>(2)) dumps core, then the process ID is always appended to the core "
4269 "filename, unless the process ID was already included elsewhere in the "
4270 "filename via a %p specification in I</proc/sys/kernel/core_pattern>. (This "
4271 "is primarily useful when employing the LinuxThreads implementation, where "
4272 "each thread of a process has a different PID.)"
4276 #: build/C/man5/core.5:322 build/C/man3/gnu_get_libc_version.3:51 build/C/man3/stdarg.3:291 build/C/man4/vcs.4:89
4282 #: build/C/man5/core.5:330
4284 "The program below can be used to demonstrate the use of the pipe syntax in "
4285 "the I</proc/sys/kernel/core_pattern> file. The following shell session "
4286 "demonstrates the use of this program (compiled to create an executable named "
4287 "I<core_pattern_pipe_test>):"
4291 #: build/C/man5/core.5:351
4294 "$B< cc -o core_pattern_pipe_test core_pattern_pipe_test.c>\n"
4297 "#B< echo \"|$PWD/core_pattern_pipe_test %p UID=%u GID=%g sig=%s\" E<gt> "
4299 "B</proc/sys/kernel/core_pattern>\n"
4302 "B<^\\e> # type control-backslash\n"
4303 "Quit (core dumped)\n"
4304 "$B< cat core.info>\n"
4306 "argc[0]=E<lt>/home/mtk/core_pattern_pipe_testE<gt>\n"
4307 "argc[1]=E<lt>20575E<gt>\n"
4308 "argc[2]=E<lt>UID=1000E<gt>\n"
4309 "argc[3]=E<lt>GID=100E<gt>\n"
4310 "argc[4]=E<lt>sig=3E<gt>\n"
4311 "Total bytes in core dump: 282624\n"
4315 #: build/C/man5/core.5:353 build/C/man3/gnu_get_libc_version.3:61
4317 msgid "Program source"
4321 #: build/C/man5/core.5:357
4323 msgid "/* core_pattern_pipe_test.c */\n"
4327 #: build/C/man5/core.5:365
4330 "#define _GNU_SOURCE\n"
4331 "#include E<lt>sys/stat.hE<gt>\n"
4332 "#include E<lt>fcntl.hE<gt>\n"
4333 "#include E<lt>limits.hE<gt>\n"
4334 "#include E<lt>stdio.hE<gt>\n"
4335 "#include E<lt>stdlib.hE<gt>\n"
4336 "#include E<lt>unistd.hE<gt>\n"
4340 #: build/C/man5/core.5:367
4342 msgid "#define BUF_SIZE 1024\n"
4346 #: build/C/man5/core.5:376
4350 "main(int argc, char *argv[])\n"
4354 " char buf[BUF_SIZE];\n"
4356 " char cwd[PATH_MAX];\n"
4360 #: build/C/man5/core.5:379
4363 " /* Change our current working directory to that of the\n"
4364 " crashing process */\n"
4368 #: build/C/man5/core.5:382
4371 " snprintf(cwd, PATH_MAX, \"/proc/%s/cwd\", argv[1]);\n"
4376 #: build/C/man5/core.5:384
4378 msgid " /* Write output to file \"core.info\" in that directory */\n"
4382 #: build/C/man5/core.5:388
4385 " fp = fopen(\"core.info\", \"w+\");\n"
4386 " if (fp == NULL)\n"
4387 " exit(EXIT_FAILURE);\n"
4391 #: build/C/man5/core.5:391
4394 " /* Display command-line arguments given to core_pattern\n"
4395 " pipe program */\n"
4399 #: build/C/man5/core.5:395
4402 " fprintf(fp, \"argc=%d\\en\", argc);\n"
4403 " for (j = 0; j E<lt> argc; j++)\n"
4404 " fprintf(fp, \"argc[%d]=E<lt>%sE<gt>\\en\", j, argv[j]);\n"
4408 #: build/C/man5/core.5:397
4410 msgid " /* Count bytes in standard input (the core dump) */\n"
4414 #: build/C/man5/core.5:402
4418 " while ((nread = read(STDIN_FILENO, buf, BUF_SIZE)) E<gt> 0)\n"
4420 " fprintf(fp, \"Total bytes in core dump: %d\\en\", tot);\n"
4424 #: build/C/man5/core.5:405
4427 " exit(EXIT_SUCCESS);\n"
4432 #: build/C/man5/core.5:417
4434 "B<bash>(1), B<gdb>(1), B<getrlimit>(2), B<mmap>(2), B<prctl>(2), "
4435 "B<sigaction>(2), B<elf>(5), B<proc>(5), B<pthreads>(7), B<signal>(7)"
4439 #: build/C/man4/cpuid.4:26
4445 #: build/C/man4/cpuid.4:26 build/C/man4/msr.4:26
4451 #: build/C/man4/cpuid.4:29
4452 msgid "cpuid - x86 CPUID access device"
4456 #: build/C/man4/cpuid.4:31
4457 msgid "CPUID provides an interface for querying information about the x86 CPU."
4461 #: build/C/man4/cpuid.4:38
4463 "This device is accessed by B<lseek>(2) or B<pread>(2) to the appropriate "
4464 "CPUID level and reading in chunks of 16 bytes. A larger read size means "
4465 "multiple reads of consecutive levels."
4469 #: build/C/man4/cpuid.4:47
4471 "The lower 32 bits of the file position is used as the incoming I<%eax>, and "
4472 "the upper 32 bits of the file position as the incoming I<%ecx>, the latter "
4473 "intended for \"counting\" I<eax> levels like I<eax=4>."
4477 #: build/C/man4/cpuid.4:57
4479 "This driver uses I</dev/cpu/CPUNUM/cpuid>, where I<CPUNUM> is the minor "
4480 "number, and on an SMP box will direct the access to CPU I<CPUNUM> as listed "
4481 "in I</proc/cpuinfo>."
4485 #: build/C/man4/cpuid.4:62
4487 "This file is protected so that it can only be read by the user I<root>, or "
4488 "members of the group I<root>."
4492 #: build/C/man4/cpuid.4:67
4494 "The CPUID instruction can be directly executed by a program using inline "
4495 "assembler. However this device allows convenient access to all CPUs without "
4496 "changing process affinity."
4500 #: build/C/man4/cpuid.4:76
4502 "Most of the information in I<cpuid> is reported by the kernel in cooked form "
4503 "either in I</proc/cpuinfo> or through subdirectories in "
4504 "I</sys/devices/system/cpu>. Direct CPUID access through this device should "
4505 "only be used in exceptional cases."
4509 #: build/C/man4/cpuid.4:82
4511 "The I<cpuid> driver is not auto-loaded. On modular kernels you might need "
4512 "to use the following command to load it explicitly before use:"
4516 #: build/C/man4/cpuid.4:84
4518 msgid " $ I<modprobe cpuid>\n"
4522 #: build/C/man4/cpuid.4:87
4524 "There is no support for CPUID functions that require additional input "
4529 #: build/C/man4/cpuid.4:89
4530 msgid "Very old x86 CPUs don't support CPUID."
4534 #: build/C/man4/cpuid.4:93
4536 "Intel Corporation, Intel 64 and IA-32 Architectures Software Developer's "
4537 "Manual Volume 2A: Instruction Set Reference, A-M, 3-180 CPUID reference."
4541 #: build/C/man4/cpuid.4:96
4543 "Intel Corporation, Intel Processor Identification and the CPUID Instruction, "
4544 "Application note 485."
4548 #: build/C/man4/dsp56k.4:27
4554 #: build/C/man4/dsp56k.4:30
4555 msgid "dsp56k - DSP56001 interface device"
4559 #: build/C/man4/dsp56k.4:33
4561 msgid "#include E<lt>asm/dsp56k.hE<gt>\n"
4565 #: build/C/man4/dsp56k.4:36
4568 "B<ssize_t read(int >I<fd>B<, void *>I<data>B<, size_t >I<length>B<);>\n"
4569 "B<ssize_t write(int >I<fd>B<, void *>I<data>B<, size_t >I<length>B<);>\n"
4573 #: build/C/man4/dsp56k.4:42
4576 "B<int ioctl(int >I<fd>B<, DSP56K_UPLOAD, struct dsp56k_upload "
4577 "*>I<program>B<);>\n"
4578 "B<int ioctl(int >I<fd>B<, DSP56K_SET_TX_WSIZE, int >I<wsize>B<);>\n"
4579 "B<int ioctl(int >I<fd>B<, DSP56K_SET_RX_WSIZE, int >I<wsize>B<);>\n"
4580 "B<int ioctl(int >I<fd>B<, DSP56K_HOST_FLAGS, struct dsp56k_host_flags "
4582 "B<int ioctl(int >I<fd>B<, DSP56K_HOST_CMD, int >I<cmd>B<);>\n"
4586 #: 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
4588 msgid "CONFIGURATION"
4592 #: build/C/man4/dsp56k.4:46
4594 "The dsp56k device is a character device with major number 55 and minor "
4599 #: build/C/man4/dsp56k.4:52
4601 "The Motorola DSP56001 is a fully programmable 24-bit digital signal "
4602 "processor found in Atari Falcon030-compatible computers. The I<dsp56k> "
4603 "special file is used to control the DSP56001, and to send and receive data "
4604 "using the bidirectional handshaked host port."
4608 #: build/C/man4/dsp56k.4:62
4610 "To send a data stream to the signal processor, use B<write>(2) to the "
4611 "device, and B<read>(2) to receive processed data. The data can be sent or "
4612 "received in 8, 16, 24, or 32-bit quantities on the host side, but will "
4613 "always be seen as 24-bit quantities in the DSP56001."
4617 #: build/C/man4/dsp56k.4:67
4618 msgid "The following B<ioctl>(2) calls are used to control the I<dsp56k> device:"
4622 #: build/C/man4/dsp56k.4:67
4624 msgid "B<DSP56K_UPLOAD>"
4628 #: build/C/man4/dsp56k.4:74
4630 "resets the DSP56001 and uploads a program. The third B<ioctl>(2) argument "
4631 "must be a pointer to a I<struct dsp56k_binary> with members I<bin> pointing "
4632 "to a DSP56001 binary program, and I<len> set to the length of the program, "
4633 "counted in 24-bit words."
4637 #: build/C/man4/dsp56k.4:74
4639 msgid "B<DSP56K_SET_TX_WSIZE>"
4643 #: build/C/man4/dsp56k.4:82
4645 "sets the transmit word size. Allowed values are in the range 1 to 4, and is "
4646 "the number of bytes that will be sent at a time to the DSP56001. These data "
4647 "quantities will either be padded with zero bytes, or truncated to fit the "
4648 "native 24-bit data format of the DSP56001."
4652 #: build/C/man4/dsp56k.4:82
4654 msgid "B<DSP56K_SET_RX_WSIZE>"
4658 #: build/C/man4/dsp56k.4:89
4660 "sets the receive word size. Allowed values are in the range 1 to 4, and is "
4661 "the number of bytes that will be received at a time from the DSP56001. "
4662 "These data quantities will either truncated, or padded with a null byte "
4663 "(\\(aq\\e0\\(aq) to fit the native 24-bit data format of the DSP56001."
4667 #: build/C/man4/dsp56k.4:89
4669 msgid "B<DSP56K_HOST_FLAGS>"
4673 #: build/C/man4/dsp56k.4:96
4675 "read and write the host flags. The host flags are four general-purpose bits "
4676 "that can be read by both the hosting computer and the DSP56001. Bits 0 and "
4677 "1 can be written by the host, and bits 2 and 3 can be written by the "
4682 #: build/C/man4/dsp56k.4:106
4684 "To access the host flags, the third B<ioctl>(2) argument must be a pointer "
4685 "to a I<struct dsp56k_host_flags>. If bit 0 or 1 is set in the I<dir> "
4686 "member, the corresponding bit in I<out> will be written to the host flags. "
4687 "The state of all host flags will be returned in the lower four bits of the "
4692 #: build/C/man4/dsp56k.4:106
4694 msgid "B<DSP56K_HOST_CMD>"
4698 #: build/C/man4/dsp56k.4:110
4700 "sends a host command. Allowed values are in the range 0 to 31, and is a "
4701 "user-defined command handled by the program running in the DSP56001."
4705 #. Fredrik Noring <noring@nocrew.org>, lars brinkhoff <lars@nocrew.org>,
4706 #. Tomas Berndtsson <tomas@nocrew.org>.
4708 #: build/C/man4/dsp56k.4:115
4713 #: build/C/man4/dsp56k.4:121
4715 "I<linux/include/asm-m68k/dsp56k.h>, I<linux/drivers/char/dsp56k.c>, E<.UR "
4716 "http://dsp56k.nocrew.org/> E<.UE ,> DSP56000/DSP56001 Digital Signal "
4717 "Processor User's Manual"
4721 #: build/C/man4/fd.4:28
4727 #: build/C/man4/fd.4:28
4733 #: build/C/man4/fd.4:31
4734 msgid "fd - floppy disk device"
4738 #: build/C/man4/fd.4:48
4740 "Floppy drives are block devices with major number 2. Typically they are "
4741 "owned by I<root.floppy> (i.e., user root, group floppy) and have either mode "
4742 "0660 (access checking via group membership) or mode 0666 (everybody has "
4743 "access). The minor numbers encode the device type, drive number, and "
4744 "controller number. For each device type (that is, combination of density "
4745 "and track count) there is a base minor number. To this base number, add "
4746 "the drive's number on its controller and 128 if the drive is on the "
4747 "secondary controller. In the following device tables, I<n> represents the "
4752 #: build/C/man4/fd.4:55
4754 "B<Warning: If you use formats with more tracks than supported by your drive, "
4755 "you may cause it mechanical damage.> Trying once if more tracks than the "
4756 "usual 40/80 are supported should not damage it, but no warranty is given for "
4757 "that. If you are not sure, don't create device entries for those formats, "
4758 "so as to prevent their usage."
4762 #: build/C/man4/fd.4:58
4764 "Drive-independent device files which automatically detect the media format "
4769 #: build/C/man4/fd.4:60
4771 msgid "Name\tBase minor #\n"
4775 #: 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
4781 #: build/C/man4/fd.4:62
4783 msgid "B<fd>I<n>\t0\n"
4787 #: build/C/man4/fd.4:66
4788 msgid "5.25 inch double density device files:"
4792 #: 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
4794 msgid "Name\tCapac.\tCyl.\tSect.\tHeads\tBase minor #\n"
4798 #: build/C/man4/fd.4:70
4800 msgid "B<fd>I<n>B<d360>\t360K\t40\t9\t2\t4\n"
4804 #: build/C/man4/fd.4:74
4805 msgid "5.25 inch high density device files:"
4809 #: build/C/man4/fd.4:78
4811 msgid "B<fd>I<n>B<h360>\t360K\t40\t9\t2\t20\n"
4815 #: build/C/man4/fd.4:79
4817 msgid "B<fd>I<n>B<h410>\t410K\t41\t10\t2\t48\n"
4821 #: build/C/man4/fd.4:80
4823 msgid "B<fd>I<n>B<h420>\t420K\t42\t10\t2\t64\n"
4827 #: build/C/man4/fd.4:81
4829 msgid "B<fd>I<n>B<h720>\t720K\t80\t9\t2\t24\n"
4833 #: build/C/man4/fd.4:82
4835 msgid "B<fd>I<n>B<h880>\t880K\t80\t11\t2\t80\n"
4839 #: build/C/man4/fd.4:83
4841 msgid "B<fd>I<n>B<h1200>\t1200K\t80\t15\t2\t8\n"
4845 #: build/C/man4/fd.4:84
4847 msgid "B<fd>I<n>B<h1440>\t1440K\t80\t18\t2\t40\n"
4851 #: build/C/man4/fd.4:85
4853 msgid "B<fd>I<n>B<h1476>\t1476K\t82\t18\t2\t56\n"
4857 #: build/C/man4/fd.4:86
4859 msgid "B<fd>I<n>B<h1494>\t1494K\t83\t18\t2\t72\n"
4863 #: build/C/man4/fd.4:87
4865 msgid "B<fd>I<n>B<h1600>\t1600K\t80\t20\t2\t92\n"
4869 #: build/C/man4/fd.4:90
4870 msgid "3.5 inch double density device files:"
4874 #: build/C/man4/fd.4:94
4876 msgid "B<fd>I<n>B<D360>\t360K\t80\t9\t1\t12\n"
4880 #: build/C/man4/fd.4:95
4882 msgid "B<fd>I<n>B<D720>\t720K\t80\t9\t2\t16\n"
4886 #: build/C/man4/fd.4:96
4888 msgid "B<fd>I<n>B<D800>\t800K\t80\t10\t2\t120\n"
4892 #: build/C/man4/fd.4:97
4894 msgid "B<fd>I<n>B<D1040>\t1040K\t80\t13\t2\t84\n"
4898 #: build/C/man4/fd.4:98
4900 msgid "B<fd>I<n>B<D1120>\t1120K\t80\t14\t2\t88\n"
4904 #: build/C/man4/fd.4:102
4905 msgid "3.5 inch high density device files:"
4909 #: build/C/man4/fd.4:106
4911 msgid "B<fd>I<n>B<H360>\t360K\t40\t9\t2\t12\n"
4915 #: build/C/man4/fd.4:107
4917 msgid "B<fd>I<n>B<H720>\t720K\t80\t9\t2\t16\n"
4921 #: build/C/man4/fd.4:108
4923 msgid "B<fd>I<n>B<H820>\t820K\t82\t10\t2\t52\n"
4927 #: build/C/man4/fd.4:109
4929 msgid "B<fd>I<n>B<H830>\t830K\t83\t10\t2\t68\n"
4933 #: build/C/man4/fd.4:110
4935 msgid "B<fd>I<n>B<H1440>\t1440K\t80\t18\t2\t28\n"
4939 #: build/C/man4/fd.4:111
4941 msgid "B<fd>I<n>B<H1600>\t1600K\t80\t20\t2\t124\n"
4945 #: build/C/man4/fd.4:112
4947 msgid "B<fd>I<n>B<H1680>\t1680K\t80\t21\t2\t44\n"
4951 #: build/C/man4/fd.4:113
4953 msgid "B<fd>I<n>B<H1722>\t1722K\t82\t21\t2\t60\n"
4957 #: build/C/man4/fd.4:114
4959 msgid "B<fd>I<n>B<H1743>\t1743K\t83\t21\t2\t76\n"
4963 #: build/C/man4/fd.4:115
4965 msgid "B<fd>I<n>B<H1760>\t1760K\t80\t22\t2\t96\n"
4969 #: build/C/man4/fd.4:116
4971 msgid "B<fd>I<n>B<H1840>\t1840K\t80\t23\t2\t116\n"
4975 #: build/C/man4/fd.4:117
4977 msgid "B<fd>I<n>B<H1920>\t1920K\t80\t24\t2\t100\n"
4981 #: build/C/man4/fd.4:121
4982 msgid "3.5 inch extra density device files:"
4986 #: build/C/man4/fd.4:125
4988 msgid "B<fd>I<n>B<E2880>\t2880K\t80\t36\t2\t32\n"
4992 #: build/C/man4/fd.4:126
4994 msgid "B<fd>I<n>B<CompaQ>\t2880K\t80\t36\t2\t36\n"
4998 #: build/C/man4/fd.4:127
5000 msgid "B<fd>I<n>B<E3200>\t3200K\t80\t40\t2\t104\n"
5004 #: build/C/man4/fd.4:128
5006 msgid "B<fd>I<n>B<E3520>\t3520K\t80\t44\t2\t108\n"
5010 #: build/C/man4/fd.4:129
5012 msgid "B<fd>I<n>B<E3840>\t3840K\t80\t48\t2\t112\n"
5016 #: build/C/man4/fd.4:136
5018 "B<fd> special files access the floppy disk drives in raw mode. The "
5019 "following B<ioctl>(2) calls are supported by B<fd> devices:"
5023 #: build/C/man4/fd.4:136
5029 #: build/C/man4/fd.4:138
5030 msgid "clears the media information of a drive (geometry of disk in drive)."
5034 #: build/C/man4/fd.4:138
5040 #: build/C/man4/fd.4:142
5042 "sets the media information of a drive. The media information will be lost "
5043 "when the media is changed."
5047 #: build/C/man4/fd.4:142
5053 #: build/C/man4/fd.4:148
5055 "sets the media information of a drive (geometry of disk in drive). The "
5056 "media information will not be lost when the media is changed. This will "
5057 "disable autodetection. In order to reenable autodetection, you have to "
5058 "issue an B<FDCLRPRM>."
5062 #: build/C/man4/fd.4:148 build/C/man4/fd.4:160
5064 msgid "B<FDGETDRVTYP>"
5068 #: build/C/man4/fd.4:153
5070 "returns the type of a drive (name parameter). For formats which work in "
5071 "several drive types, B<FDGETDRVTYP> returns a name which is appropriate for "
5072 "the oldest drive type which supports this format."
5076 #: build/C/man4/fd.4:153
5082 #: build/C/man4/fd.4:155
5083 msgid "invalidates the buffer cache for the given drive."
5087 #: build/C/man4/fd.4:155 build/C/man4/fd.4:158
5089 msgid "B<FDSETMAXERRS>"
5093 #: build/C/man4/fd.4:158
5095 "sets the error thresholds for reporting errors, aborting the operation, "
5096 "recalibrating, resetting, and reading sector by sector."
5100 #: build/C/man4/fd.4:160
5101 msgid "gets the current error thresholds."
5105 #: build/C/man4/fd.4:162
5106 msgid "gets the internal name of the drive."
5110 #: build/C/man4/fd.4:162
5112 msgid "B<FDWERRORCLR>"
5116 #: build/C/man4/fd.4:164
5117 msgid "clears the write error statistics."
5121 #: build/C/man4/fd.4:164
5123 msgid "B<FDWERRORGET>"
5127 #: build/C/man4/fd.4:171
5129 "reads the write error statistics. These include the total number of write "
5130 "errors, the location and disk of the first write error, and the location and "
5131 "disk of the last write error. Disks are identified by a generation number "
5132 "which is incremented at (almost) each disk change."
5136 #: build/C/man4/fd.4:171
5138 msgid "B<FDTWADDLE>"
5142 #: build/C/man4/fd.4:175
5144 "Switch the drive motor off for a few microseconds. This might be needed in "
5145 "order to access a disk whose sectors are too close together."
5149 #: build/C/man4/fd.4:175
5151 msgid "B<FDSETDRVPRM>"
5155 #: build/C/man4/fd.4:177
5156 msgid "sets various drive parameters."
5160 #: build/C/man4/fd.4:177
5162 msgid "B<FDGETDRVPRM>"
5166 #: build/C/man4/fd.4:179
5167 msgid "reads these parameters back."
5171 #: build/C/man4/fd.4:179
5173 msgid "B<FDGETDRVSTAT>"
5177 #: build/C/man4/fd.4:181
5178 msgid "gets the cached drive state (disk changed, write protected et al.)"
5182 #: build/C/man4/fd.4:181
5184 msgid "B<FDPOLLDRVSTAT>"
5188 #: build/C/man4/fd.4:183
5189 msgid "polls the drive and return its state."
5193 #: build/C/man4/fd.4:183
5195 msgid "B<FDGETFDCSTAT>"
5199 #: build/C/man4/fd.4:185
5200 msgid "gets the floppy controller state."
5204 #: build/C/man4/fd.4:185
5210 #: build/C/man4/fd.4:187
5211 msgid "resets the floppy controller under certain conditions."
5215 #: build/C/man4/fd.4:187
5221 #: build/C/man4/fd.4:189
5222 msgid "sends a raw command to the floppy controller."
5226 #: build/C/man4/fd.4:194
5228 "For more precise information, consult also the I<E<lt>linux/fd.hE<gt>> and "
5229 "I<E<lt>linux/fdreg.hE<gt>> include files, as well as the B<floppycontrol>(1) "
5234 #: build/C/man4/fd.4:196
5239 #: build/C/man4/fd.4:202
5241 "The various formats permit reading and writing many types of disks. "
5242 "However, if a floppy is formatted with an inter-sector gap that is too "
5243 "small, performance may drop, to the point of needing a few seconds to access "
5244 "an entire track. To prevent this, use interleaved formats."
5248 #: build/C/man4/fd.4:206
5250 "It is not possible to read floppies which are formatted using GCR (group "
5251 "code recording), which is used by Apple II and Macintosh computers (800k "
5256 #. Alain Knaff (Alain.Knaff@imag.fr), David Niemi
5257 #. (niemidc@clark.net), Bill Broadhurst (bbroad@netcom.com).
5259 #: build/C/man4/fd.4:213
5261 "Reading floppies which are hard sectored (one hole per sector, with the "
5262 "index hole being a little skewed) is not supported. This used to be common "
5263 "with older 8-inch floppies."
5267 #: build/C/man4/fd.4:221
5269 "B<chown>(1), B<floppycontrol>(1), B<getfdprm>(1), B<mknod>(1), "
5270 "B<superformat>(1), B<mount>(8), B<setfdprm>(8)"
5274 #: build/C/man7/fifo.7:13
5280 #: build/C/man7/fifo.7:13
5286 #: build/C/man7/fifo.7:16
5287 msgid "fifo - first-in first-out special file, named pipe"
5291 #: build/C/man7/fifo.7:28
5293 "A FIFO special file (a named pipe) is similar to a pipe, except that it is "
5294 "accessed as part of the file system. It can be opened by multiple processes "
5295 "for reading or writing. When processes are exchanging data via the FIFO, "
5296 "the kernel passes all data internally without writing it to the file "
5297 "system. Thus, the FIFO special file has no contents on the file system; the "
5298 "file system entry merely serves as a reference point so that processes can "
5299 "access the pipe using a name in the file system."
5303 #: build/C/man7/fifo.7:35
5305 "The kernel maintains exactly one pipe object for each FIFO special file that "
5306 "is opened by at least one process. The FIFO must be opened on both ends "
5307 "(reading and writing) before data can be passed. Normally, opening the "
5308 "FIFO blocks until the other end is opened also."
5312 #: build/C/man7/fifo.7:44
5314 "A process can open a FIFO in nonblocking mode. In this case, opening for "
5315 "read only will succeed even if no-one has opened on the write side yet, "
5316 "opening for write only will fail with B<ENXIO> (no such device or address) "
5317 "unless the other end has already been opened."
5321 #: build/C/man7/fifo.7:54
5323 "Under Linux, opening a FIFO for read and write will succeed both in blocking "
5324 "and nonblocking mode. POSIX leaves this behavior undefined. This can be "
5325 "used to open a FIFO for writing while there are no readers available. A "
5326 "process that uses both ends of the connection in order to communicate with "
5327 "itself should be very careful to avoid deadlocks."
5331 #: build/C/man7/fifo.7:59
5333 "When a process tries to write to a FIFO that is not opened for read on the "
5334 "other side, the process is sent a B<SIGPIPE> signal."
5338 #: build/C/man7/fifo.7:65
5340 "FIFO special files can be created by B<mkfifo>(3), and are indicated by I<ls "
5341 "-l> with the file type \\(aqp\\(aq."
5345 #: build/C/man7/fifo.7:74
5347 "B<mkfifo>(1), B<open>(2), B<pipe>(2), B<sigaction>(2), B<signal>(2), "
5348 "B<socketpair>(2), B<mkfifo>(3), B<pipe>(7)"
5352 #: build/C/man4/full.4:26
5358 #: build/C/man4/full.4:26
5364 #: build/C/man4/full.4:29
5365 msgid "full - always full device"
5369 #: build/C/man4/full.4:32
5371 "If your system does not have I</dev/full> created already, it can be created "
5372 "with the following commands:"
5376 #: build/C/man4/full.4:36
5379 " mknod -m 666 /dev/full c 1 7\n"
5380 " chown root:root /dev/full\n"
5384 #: build/C/man4/full.4:40
5385 msgid "File I</dev/full> has major device number 1 and minor device number 7."
5389 #: build/C/man4/full.4:45
5391 "Writes to the I</dev/full> device will fail with an B<ENOSPC> error. This "
5392 "can be used to test how a program handles disk-full errors."
5396 #: build/C/man4/full.4:47
5397 msgid "Reads from the I</dev/full> device will return \\e0 characters."
5401 #: build/C/man4/full.4:49
5402 msgid "Seeks on I</dev/full> will always succeed."
5406 #: build/C/man4/full.4:51
5411 #: build/C/man4/full.4:55
5412 msgid "B<mknod>(1), B<null>(4), B<zero>(4)"
5416 #: build/C/man3/gnu_get_libc_version.3:26
5418 msgid "GNU_GET_LIBC_VERSION"
5422 #: build/C/man3/gnu_get_libc_version.3:26
5428 #: build/C/man3/gnu_get_libc_version.3:29
5429 msgid "gnu_get_libc_version, gnu_get_libc_release - get glibc version and release"
5433 #: build/C/man3/gnu_get_libc_version.3:32
5435 msgid "B<#include E<lt>gnu/libc-version.hE<gt>>\n"
5439 #: build/C/man3/gnu_get_libc_version.3:35
5442 "B<const char *gnu_get_libc_version(void);>\n"
5443 "B<const char *gnu_get_libc_release(void);>\n"
5447 #: build/C/man3/gnu_get_libc_version.3:40
5449 "The function B<gnu_get_libc_version>() returns a string that identifies the "
5450 "glibc version available on the system."
5454 #: build/C/man3/gnu_get_libc_version.3:47
5456 "The function B<gnu_get_libc_release>() returns a string indicates the "
5457 "release status of the glibc version available on the system. This will be a "
5458 "string such as I<stable>."
5462 #: build/C/man3/gnu_get_libc_version.3:47 build/C/man4/vcs.4:87
5468 #: build/C/man3/gnu_get_libc_version.3:49
5469 msgid "These functions first appeared in glibc in version 2.1."
5473 #: 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:69 build/C/man3/stdarg.3:229 build/C/man2/syslog.2:298 build/C/man3/syslog.3:252 build/C/man7/uri.7:584
5475 msgid "CONFORMING TO"
5479 #: build/C/man3/gnu_get_libc_version.3:51
5480 msgid "These functions are glibc-specific."
5484 #: build/C/man3/gnu_get_libc_version.3:53
5485 msgid "When run, the program below will produce output such as the following:"
5489 #: build/C/man3/gnu_get_libc_version.3:59
5493 "GNU libc version: 2.8\n"
5494 "GNU libc release: stable\n"
5498 #: build/C/man3/gnu_get_libc_version.3:67
5501 "#include E<lt>gnu/libc-version.hE<gt>\n"
5502 "#include E<lt>stdlib.hE<gt>\n"
5503 "#include E<lt>stdio.hE<gt>\n"
5507 #: build/C/man3/gnu_get_libc_version.3:75
5511 "main(int argc, char *argv[])\n"
5513 " printf(\"GNU libc version: %s\\en\", gnu_get_libc_version());\n"
5514 " printf(\"GNU libc release: %s\\en\", gnu_get_libc_release());\n"
5515 " exit(EXIT_SUCCESS);\n"
5520 #: build/C/man3/gnu_get_libc_version.3:78
5521 msgid "B<confstr>(3)"
5525 #: build/C/man4/hd.4:29
5531 #: build/C/man4/hd.4:29
5537 #: build/C/man4/hd.4:32
5538 msgid "hd - MFM/IDE hard disk devices"
5542 #: build/C/man4/hd.4:39
5544 "The B<hd*> devices are block devices to access MFM/IDE hard disk drives in "
5545 "raw mode. The master drive on the primary IDE controller (major device "
5546 "number 3) is B<hda>; the slave drive is B<hdb>. The master drive of the "
5547 "second controller (major device number 22) is B<hdc> and the slave B<hdd>."
5551 #: build/C/man4/hd.4:63
5553 "General IDE block device names have the form B<hd>I<X>, or B<hd>I<XP>, where "
5554 "I<X> is a letter denoting the physical drive, and I<P> is a number denoting "
5555 "the partition on that physical drive. The first form, B<hd>I<X,> is used to "
5556 "address the whole drive. Partition numbers are assigned in the order the "
5557 "partitions are discovered, and only nonempty, nonextended partitions get a "
5558 "number. However, partition numbers 1-4 are given to the four partitions "
5559 "described in the MBR (the \"primary\" partitions), regardless of whether "
5560 "they are unused or extended. Thus, the first logical partition will be "
5561 "B<hd>I<X>B<5>\\&. Both DOS-type partitioning and BSD-disklabel partitioning "
5562 "are supported. You can have at most 63 partitions on an IDE disk."
5566 #: build/C/man4/hd.4:69
5568 "For example, I</dev/hda> refers to all of the first IDE drive in the system; "
5569 "and I</dev/hdb3> refers to the third DOS \"primary\" partition on the second "
5574 #: build/C/man4/hd.4:71 build/C/man4/ttyS.4:33
5575 msgid "They are typically created by:"
5579 #: build/C/man4/hd.4:74
5580 msgid "mknod -m 660 /dev/hda b 3 0"
5584 #: build/C/man4/hd.4:76
5585 msgid "mknod -m 660 /dev/hda1 b 3 1"
5589 #: build/C/man4/hd.4:78
5590 msgid "mknod -m 660 /dev/hda2 b 3 2"
5594 #: build/C/man4/hd.4:80 build/C/man4/hd.4:90
5599 #: build/C/man4/hd.4:82
5600 msgid "mknod -m 660 /dev/hda8 b 3 8"
5604 #: build/C/man4/hd.4:84
5605 msgid "mknod -m 660 /dev/hdb b 3 64"
5609 #: build/C/man4/hd.4:86
5610 msgid "mknod -m 660 /dev/hdb1 b 3 65"
5614 #: build/C/man4/hd.4:88
5615 msgid "mknod -m 660 /dev/hdb2 b 3 66"
5619 #: build/C/man4/hd.4:92
5620 msgid "mknod -m 660 /dev/hdb8 b 3 72"
5624 #: build/C/man4/hd.4:94
5625 msgid "chown root:disk /dev/hd*"
5629 #: build/C/man4/hd.4:97
5634 #: build/C/man4/hd.4:102
5635 msgid "B<chown>(1), B<mknod>(1), B<sd>(4), B<mount>(8)"
5639 #: build/C/man4/hpsa.4:10
5645 #: build/C/man4/hpsa.4:13
5646 msgid "hpsa - HP Smart Array SCSI driver"
5650 #: build/C/man4/hpsa.4:16
5652 msgid "modprobe hpsa [ hpsa_allow_any=1 ]\n"
5656 #: build/C/man4/hpsa.4:20
5657 msgid "B<hpsa> is a SCSI driver for HP Smart Array RAID controllers."
5661 #: build/C/man4/hpsa.4:39
5663 "I<hpsa_allow_any=1>: This option allows the driver to attempt to operate on "
5664 "any HP Smart Array hardware RAID controller, even if it is not explicitly "
5665 "known to the driver. This allows newer hardware to work with older "
5666 "drivers. Typically this is used to allow installation of operating systems "
5667 "from media that predates the RAID controller, though it may also be used to "
5668 "enable B<hpsa> to drive older controllers that would normally be handled by "
5669 "the B<cciss>(4) driver. These older boards have not been tested and are "
5670 "not supported with B<hpsa>, and B<cciss>(4) should still be used for these."
5674 #: build/C/man4/hpsa.4:43
5675 msgid "The B<hpsa> driver supports the following Smart Array boards:"
5679 #: build/C/man4/hpsa.4:54
5682 " Smart Array P700M\n"
5683 " Smart Array P212\n"
5684 " Smart Array P410\n"
5685 " Smart Array P410i\n"
5686 " Smart Array P411\n"
5687 " Smart Array P812\n"
5688 " Smart Array P712m\n"
5689 " Smart Array P711m\n"
5690 " StorageWorks P1210m\n"
5694 #: build/C/man4/hpsa.4:78
5696 "Logical drives are accessed via the SCSI disk driver (B<sd>(4)), tape drives "
5697 "via the SCSI tape driver (B<st>(4)), and the RAID controller via the SCSI "
5698 "generic driver (B<sg>(4)), with device nodes named I</dev/sd*,> I</dev/st*>, "
5699 "and I</dev/sg*>, respectively."
5703 #: build/C/man4/hpsa.4:78
5705 msgid "HPSA-specific host attribute files in /sys"
5709 #: build/C/man4/hpsa.4:79
5711 msgid "I</sys/class/scsi_host/host*/rescan>"
5715 #: build/C/man4/hpsa.4:93
5717 "This is a write-only attribute. Writing to this attribute will cause the "
5718 "driver to scan for new, changed, or removed devices (e.g,. hot-plugged tape "
5719 "drives, or newly configured or deleted logical drives, etc.) and notify the "
5720 "SCSI midlayer of any changes detected. Normally a rescan is triggered "
5721 "automatically by HP's Array Configuration Utility (either the GUI or the "
5722 "command-line variety); thus, for logical drive changes, the user should not "
5723 "normally have to use this attribute. This attribute may be useful when hot "
5724 "plugging devices like tape drives, or entire storage boxes containing "
5725 "pre-configured logical drives."
5729 #: build/C/man4/hpsa.4:93
5731 msgid "I</sys/class/scsi_host/host*/firmware_revision>"
5735 #: build/C/man4/hpsa.4:96
5736 msgid "This attribute contains the firmware version of the Smart Array."
5740 #: build/C/man4/hpsa.4:98
5741 msgid "For example:"
5745 #: build/C/man4/hpsa.4:103
5748 " # B<cd /sys/class/scsi_host/host4>\n"
5749 " # B<cat firmware_revision>\n"
5754 #: build/C/man4/hpsa.4:104
5756 msgid "HPSA-specific disk attribute files in /sys"
5760 #: build/C/man4/hpsa.4:105
5762 msgid "I</sys/class/scsi_disk/c:b:t:l/device/unique_id>"
5766 #: build/C/man4/hpsa.4:108
5767 msgid "This attribute contains a 32 hex-digit unique ID for each logical drive."
5771 #: build/C/man4/hpsa.4:111 build/C/man4/hpsa.4:122 build/C/man4/hpsa.4:136
5773 msgid "For example:\n"
5777 #: build/C/man4/hpsa.4:115
5780 " # B<cd /sys/class/scsi_disk/4:0:0:0/device>\n"
5781 " # B<cat unique_id>\n"
5782 " 600508B1001044395355323037570F77\n"
5786 #: build/C/man4/hpsa.4:116
5788 msgid "I</sys/class/scsi_disk/c:b:t:l/device/raid_level>"
5792 #: build/C/man4/hpsa.4:119
5793 msgid "This attribute contains the RAID level of each logical drive."
5797 #: build/C/man4/hpsa.4:126
5800 " # B<cd /sys/class/scsi_disk/4:0:0:0/device>\n"
5801 " # B<cat raid_level>\n"
5806 #: build/C/man4/hpsa.4:127
5808 msgid "I</sys/class/scsi_disk/c:b:t:l/device/lunid>"
5812 #: build/C/man4/hpsa.4:133
5814 "This attribute contains the 16 hex-digit (8 byte) LUN ID by which a logical "
5815 "drive or physical device can be addressed. I<c>:I<b>:I<t>:I<l> are the "
5816 "controller, bus, target and lun of the device."
5820 #: build/C/man4/hpsa.4:140
5823 " # B<cd /sys/class/scsi_disk/4:0:0:0/device>\n"
5825 " 0x0000004000000000\n"
5829 #: build/C/man4/hpsa.4:141
5831 msgid "Supported ioctl() operations"
5835 #: build/C/man4/hpsa.4:153
5837 "For compatibility with applications written for the B<cciss>(4) driver, "
5838 "many, but not all of the ioctls supported by the B<cciss>(4) driver are "
5839 "also supported by the B<hpsa> driver. The data structures used by these "
5840 "ioctls are described in the Linux kernel source file "
5841 "I<include/linux/cciss_ioctl.h>."
5845 #: build/C/man4/hpsa.4:153
5847 msgid "B<CCISS_DEREGDISK>, B<CCISS_REGNEWDISK>, B<CCISS_REGNEWD>"
5851 #: build/C/man4/hpsa.4:159
5853 "These three ioctls all do exactly the same thing, which is to cause the "
5854 "driver to rescan for new devices. This does exactly the same thing as "
5855 "writing to the hpsa-specific host \"rescan\" attribute."
5859 #: build/C/man4/hpsa.4:159
5861 msgid "B<CCISS_GETPCIINFO>"
5865 #: build/C/man4/hpsa.4:162
5867 "Returns PCI domain, bus, device and function and \"board ID\" (PCI subsystem "
5872 #: build/C/man4/hpsa.4:162
5874 msgid "B<CCISS_GETDRIVVER>"
5878 #: build/C/man4/hpsa.4:165
5879 msgid "Returns driver version in three bytes encoded as:"
5883 #: build/C/man4/hpsa.4:168
5886 " (major_version E<lt>E<lt> 16) | (minor_version E<lt>E<lt> 8) |\n"
5887 " (subminor_version)\n"
5891 #: build/C/man4/hpsa.4:168
5893 msgid "B<CCISS_PASSTHRU>, B<CCISS_BIG_PASSTHRU>"
5897 #: build/C/man4/hpsa.4:179
5899 "Allows \"BMIC\" and \"CISS\" commands to be passed through to the Smart "
5900 "Array. These are used extensively by the HP Array Configuration Utility, "
5901 "SNMP storage agents, etc. See I<cciss_vol_status> at E<.UR "
5902 "http://cciss.sf.net> E<.UE> for some examples."
5906 #: build/C/man4/hpsa.4:186
5908 "B<cciss>(4), B<sd>(4), B<st>(4), B<cciss_vol_status>(8), B<hpacucli>(8), "
5913 #. Don Brace, Steve Cameron, Tom Lawler, Mike Miller, Scott Teel
5914 #. and probably some other people.
5916 #: build/C/man4/hpsa.4:197
5918 "E<.UR http://cciss.sf.net> E<.UE ,> and I<Documentation/scsi/hpsa.txt> and "
5919 "I<Documentation/ABI/testing/sysfs-bus-pci-devices-cciss> in the Linux kernel "
5924 #: build/C/man4/initrd.4:35
5930 #: build/C/man4/initrd.4:35 build/C/man4/st.4:25
5936 #: build/C/man4/initrd.4:38
5937 msgid "initrd - boot loader initialized RAM disk"
5941 #: build/C/man4/initrd.4:51
5943 "The I</dev/initrd> is a read-only block device assigned major number 1 and "
5944 "minor number 250. Typically I</dev/initrd> is owned by I<root.disk> with "
5945 "mode 0400 (read access by root only). If the Linux system does not have "
5946 "I</dev/initrd> already created, it can be created with the following "
5951 #: build/C/man4/initrd.4:56
5955 " mknod -m 400 /dev/initrd b 1 250\n"
5956 " chown root:disk /dev/initrd>\n"
5961 #: build/C/man4/initrd.4:71
5963 "Also, support for both \"RAM disk\" and \"Initial RAM disk\" (e.g., "
5964 "B<CONFIG_BLK_DEV_RAM=y> and B<CONFIG_BLK_DEV_INITRD=y>) must be compiled "
5965 "directly into the Linux kernel to use I</dev/initrd>. When using "
5966 "I</dev/initrd>, the RAM disk driver cannot be loaded as a module."
5970 #: build/C/man4/initrd.4:80
5972 "The special file I</dev/initrd> is a read-only block device. This device is "
5973 "a RAM disk that is initialized (e.g., loaded) by the boot loader before the "
5974 "kernel is started. The kernel then can use I</dev/initrd>'s contents for a "
5975 "two-phase system boot-up."
5979 #: build/C/man4/initrd.4:93
5981 "In the first boot-up phase, the kernel starts up and mounts an initial root "
5982 "file-system from the contents of I</dev/initrd> (e.g., RAM disk initialized "
5983 "by the boot loader). In the second phase, additional drivers or other "
5984 "modules are loaded from the initial root device's contents. After loading "
5985 "the additional modules, a new root file system (i.e., the normal root file "
5986 "system) is mounted from a different device."
5990 #: build/C/man4/initrd.4:93
5992 msgid "Boot-up operation"
5996 #: build/C/man4/initrd.4:97
5997 msgid "When booting up with B<initrd>, the system boots as follows:"
6001 #: build/C/man4/initrd.4:101
6003 "The boot loader loads the kernel program and I</dev/initrd>'s contents into "
6008 #: build/C/man4/initrd.4:109
6010 "On kernel startup, the kernel uncompresses and copies the contents of the "
6011 "device I</dev/initrd> onto device I</dev/ram0> and then frees the memory "
6012 "used by I</dev/initrd>."
6016 #: build/C/man4/initrd.4:109 build/C/man4/initrd.4:339 build/C/man4/initrd.4:458 build/C/man4/st.4:919
6022 #: build/C/man4/initrd.4:113
6024 "The kernel then read-write mounts the device I</dev/ram0> as the initial "
6029 #: build/C/man4/initrd.4:113 build/C/man4/initrd.4:343 build/C/man4/st.4:926
6035 #: build/C/man4/initrd.4:118
6037 "If the indicated normal root file system is also the initial root "
6038 "file-system (e.g., I</dev/ram0>) then the kernel skips to the last step for "
6039 "the usual boot sequence."
6043 #: build/C/man4/initrd.4:118 build/C/man4/initrd.4:349 build/C/man4/st.4:931
6049 #: build/C/man4/initrd.4:130
6051 "If the executable file I</linuxrc> is present in the initial root "
6052 "file-system, I</linuxrc> is executed with UID 0. (The file I</linuxrc> must "
6053 "have executable permission. The file I</linuxrc> can be any valid "
6054 "executable, including a shell script.)"
6058 #: build/C/man4/initrd.4:130 build/C/man4/initrd.4:358
6064 #: build/C/man4/initrd.4:142
6066 "If I</linuxrc> is not executed or when I</linuxrc> terminates, the normal "
6067 "root file system is mounted. (If I</linuxrc> exits with any file-systems "
6068 "mounted on the initial root file-system, then the behavior of the kernel is "
6069 "B<UNSPECIFIED>. See the NOTES section for the current kernel behavior.)"
6073 #: build/C/man4/initrd.4:142 build/C/man4/initrd.4:360
6079 #: build/C/man4/initrd.4:173
6081 "If the normal root file system has a directory I</initrd>, the device "
6082 "I</dev/ram0> is moved from I</> to I</initrd>. Otherwise if the directory "
6083 "I</initrd> does not exist, the device I</dev/ram0> is unmounted. (When "
6084 "moved from I</> to I</initrd>, I</dev/ram0> is not unmounted and therefore "
6085 "processes can remain running from I</dev/ram0>. If directory I</initrd> "
6086 "does not exist on the normal root file system and any processes remain "
6087 "running from I</dev/ram0> when I</linuxrc> exits, the behavior of the kernel "
6088 "is B<UNSPECIFIED>. See the NOTES section for the current kernel behavior.)"
6092 #: build/C/man4/initrd.4:173 build/C/man4/initrd.4:363
6098 #: build/C/man4/initrd.4:180
6100 "The usual boot sequence (e.g., invocation of I</sbin/init>) is performed on "
6101 "the normal root file system."
6105 #: build/C/man4/initrd.4:184
6107 "The following boot loader options, when used with B<initrd>, affect the "
6108 "kernel's boot-up operation:"
6112 #: build/C/man4/initrd.4:184
6114 msgid "B<initrd=>I<filename>"
6118 #: build/C/man4/initrd.4:199
6120 "Specifies the file to load as the contents of I</dev/initrd>. For "
6121 "B<LOADLIN> this is a command-line option. For B<LILO> you have to use this "
6122 "command in the B<LILO> configuration file I</etc/lilo.config>. The filename "
6123 "specified with this option will typically be a gzipped file-system image."
6127 #: build/C/man4/initrd.4:199
6133 #: build/C/man4/initrd.4:214
6135 "This boot option disables the two-phase boot-up operation. The kernel "
6136 "performs the usual boot sequence as if I</dev/initrd> was not initialized. "
6137 "With this option, any contents of I</dev/initrd> loaded into memory by the "
6138 "boot loader contents are preserved. This option permits the contents of "
6139 "I</dev/initrd> to be any data and need not be limited to a file system "
6140 "image. However, device I</dev/initrd> is read-only and can be read only one "
6141 "time after system startup."
6145 #: build/C/man4/initrd.4:214
6147 msgid "B<root=>I<device-name>"
6151 #: build/C/man4/initrd.4:232
6153 "Specifies the device to be used as the normal root file system. For "
6154 "B<LOADLIN> this is a command-line option. For B<LILO> this is a boot time "
6155 "option or can be used as an option line in the B<LILO> configuration file "
6156 "I</etc/lilo.config>. The device specified by the this option must be a "
6157 "mountable device having a suitable root file-system."
6161 #: build/C/man4/initrd.4:232
6163 msgid "Changing the normal root file system"
6167 #: build/C/man4/initrd.4:252
6169 "By default, the kernel's settings (e.g., set in the kernel file with "
6170 "B<rdev>(8) or compiled into the kernel file), or the boot loader option "
6171 "setting is used for the normal root file systems. For an NFS-mounted normal "
6172 "root file system, one has to use the B<nfs_root_name> and B<nfs_root_addrs> "
6173 "boot options to give the NFS settings. For more information on NFS-mounted "
6174 "root see the kernel documentation file "
6175 "B<Documentation/filesystems/nfsroot.txt>. For more information on setting "
6176 "the root file system see also the B<LILO> and B<LOADLIN> documentation."
6180 #: build/C/man4/initrd.4:284
6182 "It is also possible for the I</linuxrc> executable to change the normal root "
6183 "device. For I</linuxrc> to change the normal root device, I</proc> must be "
6184 "mounted. After mounting I</proc>, I</linuxrc> changes the normal root "
6185 "device by writing into the proc files I</proc/sys/kernel/real-root-dev>, "
6186 "I</proc/sys/kernel/nfs-root-name>, and I</proc/sys/kernel/nfs-root-addrs>. "
6187 "For a physical root device, the root device is changed by having I</linuxrc> "
6188 "write the new root file system device number into "
6189 "I</proc/sys/kernel/real-root-dev>. For an NFS root file system, the root "
6190 "device is changed by having I</linuxrc> write the NFS setting into files "
6191 "I</proc/sys/kernel/nfs-root-name> and I</proc/sys/kernel/nfs-root-addrs> and "
6192 "then writing 0xff (e.g., the pseudo-NFS-device number) into file "
6193 "I</proc/sys/kernel/real-root-dev>. For example, the following shell command "
6194 "line would change the normal root device to I</dev/hdb1>:"
6198 #: build/C/man4/initrd.4:287
6200 msgid " echo 0x365 E<gt>/proc/sys/kernel/real-root-dev\n"
6204 #: build/C/man4/initrd.4:294
6206 "For an NFS example, the following shell command lines would change the "
6207 "normal root device to the NFS directory I</var/nfsroot> on a local networked "
6208 "NFS server with IP number 193.8.232.7 for a system with IP number "
6209 "193.8.232.2 and named \"idefix\":"
6213 #: build/C/man4/initrd.4:300
6216 " echo /var/nfsroot E<gt>/proc/sys/kernel/nfs-root-name\n"
6217 " echo 193.8.232.2:193.8.232.7::255.255.255.0:idefix \\e\n"
6218 " E<gt>/proc/sys/kernel/nfs-root-addrs\n"
6219 " echo 255 E<gt>/proc/sys/kernel/real-root-dev\n"
6222 #. FIXME the manual page should describe the pivot_root mechanism.
6224 #: build/C/man4/initrd.4:317
6226 "B<Note>: The use of I</proc/sys/kernel/real-root-dev> to change the root "
6227 "file system is obsolete. See the Linux kernel source file "
6228 "I<Documentation/initrd.txt> as well as B<pivot_root>(2) and "
6229 "B<pivot_root>(8) for information on the modern method of changing the root "
6234 #: build/C/man4/initrd.4:317 build/C/man4/random.4:65 build/C/man7/uri.7:109
6240 #: build/C/man4/initrd.4:321
6242 "The main motivation for implementing B<initrd> was to allow for modular "
6243 "kernel configuration at system installation."
6247 #: build/C/man4/initrd.4:323
6248 msgid "A possible system installation scenario is as follows:"
6252 #: build/C/man4/initrd.4:331
6254 "The loader program boots from floppy or other media with a minimal kernel "
6255 "(e.g., support for I</dev/ram>, I</dev/initrd>, and the ext2 file-system) "
6256 "and loads I</dev/initrd> with a gzipped version of the initial file-system."
6260 #: build/C/man4/initrd.4:339
6262 "The executable I</linuxrc> determines what is needed to (1) mount the normal "
6263 "root file-system (i.e., device type, device drivers, file system) and (2) "
6264 "the distribution media (e.g., CD-ROM, network, tape, ...). This can be done "
6265 "by asking the user, by auto-probing, or by using a hybrid approach."
6269 #: build/C/man4/initrd.4:343
6271 "The executable I</linuxrc> loads the necessary modules from the initial root "
6276 #: build/C/man4/initrd.4:349
6278 "The executable I</linuxrc> creates and populates the root file system. (At "
6279 "this stage the normal root file system does not have to be a completed "
6284 #: build/C/man4/initrd.4:358
6286 "The executable I</linuxrc> sets I</proc/sys/kernel/real-root-dev>, unmount "
6287 "I</proc>, the normal root file system and any other file systems it has "
6288 "mounted, and then terminates."
6292 #: build/C/man4/initrd.4:360
6293 msgid "The kernel then mounts the normal root file system."
6297 #: build/C/man4/initrd.4:363
6299 "Now that the file system is accessible and intact, the boot loader can be "
6304 #: build/C/man4/initrd.4:372
6306 "The boot loader is configured to load into I</dev/initrd> a file system with "
6307 "the set of modules that was used to bring up the system. (e.g., Device "
6308 "I</dev/ram0> can be modified, then unmounted, and finally, the image is "
6309 "written from I</dev/ram0> to a file.)"
6313 #: build/C/man4/initrd.4:372
6319 #: build/C/man4/initrd.4:375
6321 "The system is now bootable and additional installation tasks can be "
6326 #: build/C/man4/initrd.4:381
6328 "The key role of I</dev/initrd> in the above is to reuse the configuration "
6329 "data during normal system operation without requiring initial kernel "
6330 "selection, a large generic kernel or, recompiling the kernel."
6334 #: build/C/man4/initrd.4:394
6336 "A second scenario is for installations where Linux runs on systems with "
6337 "different hardware configurations in a single administrative network. In "
6338 "such cases, it may be desirable to use only a small set of kernels (ideally "
6339 "only one) and to keep the system-specific part of configuration information "
6340 "as small as possible. In this case, create a common file with all needed "
6341 "modules. Then, only the I</linuxrc> file or a file executed by I</linuxrc> "
6342 "would be different."
6346 #: build/C/man4/initrd.4:401
6348 "A third scenario is more convenient recovery disks. Because information "
6349 "like the location of the root file-system partition is not needed at boot "
6350 "time, the system loaded from I</dev/initrd> can use a dialog and/or "
6351 "auto-detection followed by a possible sanity check."
6355 #: build/C/man4/initrd.4:418
6357 "Last but not least, Linux distributions on CD-ROM may use B<initrd> for easy "
6358 "installation from the CD-ROM. The distribution can use B<LOADLIN> to "
6359 "directly load I</dev/initrd> from CD-ROM without the need of any floppies. "
6360 "The distribution could also use a B<LILO> boot floppy and then bootstrap a "
6361 "bigger RAM disk via I</dev/initrd> from the CD-ROM."
6365 #: build/C/man4/initrd.4:420
6366 msgid "I</dev/initrd>"
6370 #: build/C/man4/initrd.4:422
6371 msgid "I</dev/ram0>"
6375 #: build/C/man4/initrd.4:424
6380 #: build/C/man4/initrd.4:429
6385 #: build/C/man4/initrd.4:441
6387 "With the current kernel, any file systems that remain mounted when "
6388 "I</dev/ram0> is moved from I</> to I</initrd> continue to be accessible. "
6389 "However, the I</proc/mounts> entries are not updated."
6393 #: build/C/man4/initrd.4:458
6395 "With the current kernel, if directory I</initrd> does not exist, then "
6396 "I</dev/ram0> will B<not> be fully unmounted if I</dev/ram0> is used by any "
6397 "process or has any file-system mounted on it. If I</dev/ram0> is B<not> "
6398 "fully unmounted, then I</dev/ram0> will remain in memory."
6405 #. The kernel code for device
6407 #. was written by Werner Almesberger <almesber@lrc.epfl.ch> and
6408 #. Hans Lermen <lermen@elserv.ffm.fgan.de>.
6411 #. was added to the baseline Linux kernel in development version 1.3.73.
6413 #: build/C/man4/initrd.4:474
6415 "Users of I</dev/initrd> should not depend on the behavior give in the above "
6416 "notes. The behavior may change in future versions of the Linux kernel."
6420 #: build/C/man4/initrd.4:480
6421 msgid "B<chown>(1), B<mknod>(1), B<ram>(4), B<freeramdisk>(8), B<rdev>(8)"
6425 #: build/C/man4/initrd.4:484
6427 "I<Documentation/initrd.txt> in the Linux kernel source tree, the LILO "
6428 "documentation, the LOADLIN documentation, the SYSLINUX documentation"
6432 #: build/C/man4/lp.4:27
6438 #: build/C/man4/lp.4:27
6444 #: build/C/man4/lp.4:30
6445 msgid "lp - line printer devices"
6449 #: build/C/man4/lp.4:32
6450 msgid "B<#include E<lt>linux/lp.hE<gt>>"
6454 #: build/C/man4/lp.4:43
6456 "B<lp>[0\\(en2] are character devices for the parallel line printers; they "
6457 "have major number 6 and minor number 0\\(en2. The minor numbers correspond "
6458 "to the printer port base addresses 0x03bc, 0x0378 and 0x0278. Usually they "
6459 "have mode 220 and are owned by root and group lp. You can use printer ports "
6460 "either with polling or with interrupts. Interrupts are recommended when "
6461 "high traffic is expected, for example, for laser printers. For usual dot "
6462 "matrix printers polling will usually be enough. The default is polling."
6466 #: build/C/man4/lp.4:47
6467 msgid "The following B<ioctl>(2) calls are supported:"
6471 #: build/C/man4/lp.4:47
6473 msgid "B<int ioctl(int >I<fd>B<, LPTIME, int >I<arg>B<)>"
6477 #: build/C/man4/lp.4:55
6479 "Sets the amount of time that the driver sleeps before rechecking the printer "
6480 "when the printer's buffer appears to be filled to I<arg>. If you have a "
6481 "fast printer, decrease this number; if you have a slow printer then increase "
6482 "it. This is in hundredths of a second, the default 2 being 0.02 seconds. "
6483 "It only influences the polling driver."
6487 #: build/C/man4/lp.4:55
6489 msgid "B<int ioctl(int >I<fd>B<, LPCHAR, int >I<arg>B<)>"
6493 #: build/C/man4/lp.4:63
6495 "Sets the maximum number of busy-wait iterations which the polling driver "
6496 "does while waiting for the printer to get ready for receiving a character to "
6497 "I<arg>. If printing is too slow, increase this number; if the system gets "
6498 "too slow, decrease this number. The default is 1000. It only influences "
6499 "the polling driver."
6503 #: build/C/man4/lp.4:63
6505 msgid "B<int ioctl(int >I<fd>B<, LPABORT, int >I<arg>B<)>"
6509 #: build/C/man4/lp.4:67
6511 "If I<arg> is 0, the printer driver will retry on errors, otherwise it will "
6512 "abort. The default is 0."
6516 #: build/C/man4/lp.4:67
6518 msgid "B<int ioctl(int >I<fd>B<, LPABORTOPEN, int >I<arg>B<)>"
6522 #: build/C/man4/lp.4:72
6524 "If I<arg> is 0, B<open>(2) will be aborted on error, otherwise error will "
6525 "be ignored. The default is to ignore it."
6529 #: build/C/man4/lp.4:72
6531 msgid "B<int ioctl(int >I<fd>B<, LPCAREFUL, int >I<arg>B<)>"
6535 #: build/C/man4/lp.4:76
6537 "If I<arg> is 0, then the out-of-paper, offline and error signals are "
6538 "required to be false on all writes, otherwise they are ignored. The default "
6539 "is to ignore them."
6543 #: build/C/man4/lp.4:76
6545 msgid "B<int ioctl(int >I<fd>B<, LPWAIT, int >I<arg>B<)>"
6549 #: build/C/man4/lp.4:86
6551 "Sets the number of busy waiting iterations to wait before strobing the "
6552 "printer to accept a just-written character, and the number of iterations to "
6553 "wait before turning the strobe off again, to I<arg>. The specification says "
6554 "this time should be 0.5 microseconds, but experience has shown the delay "
6555 "caused by the code is already enough. For that reason, the default value is "
6556 "0. This is used for both the polling and the interrupt driver."
6560 #: build/C/man4/lp.4:86
6562 msgid "B<int ioctl(int >I<fd>B<, LPSETIRQ, int >I<arg>B<)>"
6566 #: build/C/man4/lp.4:95
6568 "This B<ioctl>(2) requires superuser privileges. It takes an I<int> "
6569 "containing the new IRQ as argument. As a side effect, the printer will be "
6570 "reset. When I<arg> is 0, the polling driver will be used, which is also "
6575 #: build/C/man4/lp.4:95
6577 msgid "B<int ioctl(int >I<fd>B<, LPGETIRQ, int *>I<arg>B<)>"
6581 #: build/C/man4/lp.4:97
6582 msgid "Stores the currently used IRQ in I<arg>."
6586 #: build/C/man4/lp.4:97
6588 msgid "B<int ioctl(int >I<fd>B<, LPGETSTATUS, int *>I<arg>B<)>"
6592 #: build/C/man4/lp.4:100
6594 "Stores the value of the status port in I<arg>. The bits have the following "
6599 #: build/C/man4/lp.4:102
6601 msgid "LP_PBUSY\tinverted busy input, active high\n"
6605 #: build/C/man4/lp.4:103
6607 msgid "LP_PACK\tunchanged acknowledge input, active low\n"
6611 #: build/C/man4/lp.4:104
6613 msgid "LP_POUTPA\tunchanged out-of-paper input, active high\n"
6617 #: build/C/man4/lp.4:105
6619 msgid "LP_PSELECD\tunchanged selected input, active high\n"
6623 #: build/C/man4/lp.4:106
6625 msgid "LP_PERRORP\tunchanged error input, active low\n"
6629 #: build/C/man4/lp.4:111
6631 "Refer to your printer manual for the meaning of the signals. Note that "
6632 "undocumented bits may also be set, depending on your printer."
6636 #: build/C/man4/lp.4:111
6638 msgid "B<int ioctl(int >I<fd>B<, LPRESET)>"
6642 #: build/C/man4/lp.4:114
6643 msgid "Resets the printer. No argument is used."
6647 #. The printer driver was originally written by Jim Weigand and Linus
6649 #. It was further improved by Michael K.\& Johnson.
6650 #. The interrupt code was written by Nigel Gamble.
6651 #. Alan Cox modularized it.
6652 #. LPCAREFUL, LPABORT, LPGETSTATUS were added by Chris Metcalf.
6654 #: build/C/man4/lp.4:123
6659 #: build/C/man4/lp.4:129
6660 msgid "B<chmod>(1), B<chown>(1), B<mknod>(1), B<lpcntl>(8), B<tunelp>(8)"
6664 #: build/C/man3/makedev.3:26
6670 #: build/C/man3/makedev.3:26
6676 #: build/C/man3/makedev.3:29
6677 msgid "makedev, major, minor - manage a device number"
6681 #: build/C/man3/makedev.3:33
6684 "B<#define _BSD_SOURCE> /* See feature_test_macros(7) */\n"
6685 "B<#include E<lt>sys/types.hE<gt>>\n"
6689 #: build/C/man3/makedev.3:35
6691 msgid "B<dev_t makedev(int >I<maj>B<, int >I<min>B<);>\n"
6695 #: build/C/man3/makedev.3:38
6698 "B<unsigned int major(dev_t >I<dev>B<);>\n"
6699 "B<unsigned int minor(dev_t >I<dev>B<);>\n"
6703 #: build/C/man3/makedev.3:45
6705 "A device ID consists of two parts: a major ID, identifying the class of the "
6706 "device, and a minor ID, identifying a specific instance of a device in that "
6707 "class. A device ID is represented using the type I<dev_t>."
6711 #: build/C/man3/makedev.3:52
6713 "Given major and minor device IDs, B<makedev>() combines these to produce a "
6714 "device ID, returned as the function result. This device ID can be given to "
6715 "B<mknod>(2), for example."
6719 #: build/C/man3/makedev.3:62
6721 "The B<major>() and B<minor>() functions perform the converse task: given a "
6722 "device ID, they return, respectively, the major and minor components. These "
6723 "macros can be useful to, for example, decompose the device IDs in the "
6724 "structure returned by B<stat>(2)."
6727 #. The BSDs, HP-UX, Solaris, AIX, Irix
6729 #: build/C/man3/makedev.3:71
6731 "The B<makedev>(), B<major>(), and B<minor>() functions are not specified in "
6732 "POSIX.1, but are present on many other systems."
6736 #: build/C/man3/makedev.3:80
6738 "These interfaces are defined as macros. Since glibc 2.3.3, they have been "
6739 "aliases for three GNU-specific functions: B<gnu_dev_makedev>(), "
6740 "B<gnu_dev_major>(), and B<gnu_dev_minor>(). The latter names are exported, "
6741 "but the traditional names are more portable."
6745 #: build/C/man3/makedev.3:83
6746 msgid "B<mknod>(2), B<stat>(2)"
6750 #: build/C/man4/mem.4:26
6756 #: build/C/man4/mem.4:26 build/C/man4/ram.4:26
6762 #: build/C/man4/mem.4:29
6763 msgid "mem, kmem, port - system memory, kernel memory and system ports"
6767 #: build/C/man4/mem.4:33
6769 "B<mem> is a character device file that is an image of the main memory of the "
6770 "computer. It may be used, for example, to examine (and even patch) the "
6775 #: build/C/man4/mem.4:38
6777 "Byte addresses in B<mem> are interpreted as physical memory addresses. "
6778 "References to nonexistent locations cause errors to be returned."
6782 #: build/C/man4/mem.4:41
6784 "Examining and patching is likely to lead to unexpected results when "
6785 "read-only or write-only bits are present."
6789 #: build/C/man4/mem.4:43 build/C/man4/mem.4:58 build/C/man4/mem.4:70 build/C/man4/ram.4:33
6790 msgid "It is typically created by:"
6794 #: build/C/man4/mem.4:46
6795 msgid "mknod -m 660 /dev/mem c 1 1"
6799 #: build/C/man4/mem.4:48
6800 msgid "chown root:kmem /dev/mem"
6804 #: build/C/man4/mem.4:56
6806 "The file B<kmem> is the same as B<mem>, except that the kernel virtual "
6807 "memory rather than physical memory is accessed."
6811 #: build/C/man4/mem.4:61
6812 msgid "mknod -m 640 /dev/kmem c 1 2"
6816 #: build/C/man4/mem.4:63
6817 msgid "chown root:kmem /dev/kmem"
6821 #: build/C/man4/mem.4:68
6822 msgid "B<port> is similar to B<mem>, but the I/O ports are accessed."
6826 #: build/C/man4/mem.4:73
6827 msgid "mknod -m 660 /dev/port c 1 4"
6831 #: build/C/man4/mem.4:75
6832 msgid "chown root:mem /dev/port"
6836 #: build/C/man4/mem.4:78
6841 #: build/C/man4/mem.4:80
6842 msgid "I</dev/kmem>"
6846 #: build/C/man4/mem.4:82
6847 msgid "I</dev/port>"
6851 #: build/C/man4/mem.4:86
6852 msgid "B<chown>(1), B<mknod>(1), B<ioperm>(2)"
6856 #: build/C/man3/mkfifo.3:27
6862 #: build/C/man3/mkfifo.3:27 build/C/man2/mknod.2:14
6868 #: build/C/man3/mkfifo.3:27
6874 #: build/C/man3/mkfifo.3:30
6875 msgid "mkfifo - make a FIFO special file (a named pipe)"
6879 #: build/C/man3/mkfifo.3:34
6882 "B<#include E<lt>sys/types.hE<gt>>\n"
6883 "B<#include E<lt>sys/stat.hE<gt>>\n"
6887 #: build/C/man3/mkfifo.3:36
6889 msgid "B<int mkfifo(const char *>I<pathname>B<, mode_t >I<mode>B<);>\n"
6893 #: build/C/man3/mkfifo.3:44
6895 "B<mkfifo>() makes a FIFO special file with name I<pathname>. I<mode> "
6896 "specifies the FIFO's permissions. It is modified by the process's B<umask> "
6897 "in the usual way: the permissions of the created file are B<(>I<mode>B< & "
6902 #: build/C/man3/mkfifo.3:51
6904 "A FIFO special file is similar to a pipe, except that it is created in a "
6905 "different way. Instead of being an anonymous communications channel, a FIFO "
6906 "special file is entered into the file system by calling B<mkfifo>()."
6910 #: build/C/man3/mkfifo.3:61
6912 "Once you have created a FIFO special file in this way, any process can open "
6913 "it for reading or writing, in the same way as an ordinary file. However, it "
6914 "has to be open at both ends simultaneously before you can proceed to do any "
6915 "input or output operations on it. Opening a FIFO for reading normally "
6916 "blocks until some other process opens the same FIFO for writing, and vice "
6917 "versa. See B<fifo>(7) for nonblocking handling of FIFO special files."
6921 #: build/C/man3/mkfifo.3:67
6923 "On success B<mkfifo>() returns 0. In the case of an error, -1 is returned "
6924 "(in which case, I<errno> is set appropriately)."
6928 #: build/C/man3/mkfifo.3:68 build/C/man2/mknod.2:107 build/C/man4/st.4:829
6934 #: build/C/man3/mkfifo.3:72
6936 "One of the directories in I<pathname> did not allow search (execute) "
6941 #: build/C/man3/mkfifo.3:72 build/C/man2/mknod.2:115
6947 #: build/C/man3/mkfifo.3:76 build/C/man2/mknod.2:119
6949 "The user's quota of disk blocks or inodes on the file system has been "
6954 #: build/C/man3/mkfifo.3:76 build/C/man2/mknod.2:119
6960 #: build/C/man3/mkfifo.3:82 build/C/man2/mknod.2:126
6962 "I<pathname> already exists. This includes the case where I<pathname> is a "
6963 "symbolic link, dangling or not."
6967 #: build/C/man3/mkfifo.3:82 build/C/man2/mknod.2:138
6969 msgid "B<ENAMETOOLONG>"
6973 #: build/C/man3/mkfifo.3:90
6975 "Either the total length of I<pathname> is greater than B<PATH_MAX>, or an "
6976 "individual filename component has a length greater than B<NAME_MAX>. In the "
6977 "GNU system, there is no imposed limit on overall filename length, but some "
6978 "file systems may place limits on the length of a component."
6982 #: build/C/man3/mkfifo.3:90 build/C/man2/mknod.2:141
6988 #: build/C/man3/mkfifo.3:94 build/C/man2/mknod.2:146
6990 "A directory component in I<pathname> does not exist or is a dangling "
6995 #: build/C/man3/mkfifo.3:94 build/C/man2/mknod.2:149 build/C/man4/st.4:857
7001 #: build/C/man3/mkfifo.3:97
7002 msgid "The directory or file system has no room for the new file."
7006 #: build/C/man3/mkfifo.3:97 build/C/man2/mknod.2:154
7012 #: build/C/man3/mkfifo.3:101 build/C/man2/mknod.2:159
7013 msgid "A component used as a directory in I<pathname> is not, in fact, a directory."
7017 #: build/C/man3/mkfifo.3:101 build/C/man2/mknod.2:173 build/C/man4/st.4:872
7023 #: build/C/man3/mkfifo.3:104
7024 msgid "I<pathname> refers to a read-only file system."
7028 #: build/C/man3/mkfifo.3:106
7029 msgid "POSIX.1-2001."
7033 #: build/C/man3/mkfifo.3:116
7035 "B<mkfifo>(1), B<close>(2), B<open>(2), B<read>(2), B<stat>(2), B<umask>(2), "
7036 "B<write>(2), B<mkfifoat>(3), B<fifo>(7)"
7040 #: build/C/man2/mknod.2:14
7046 #: build/C/man2/mknod.2:17
7047 msgid "mknod - create a special or ordinary file"
7051 #: build/C/man2/mknod.2:23
7054 "B<#include E<lt>sys/types.hE<gt>>\n"
7055 "B<#include E<lt>sys/stat.hE<gt>>\n"
7056 "B<#include E<lt>fcntl.hE<gt>>\n"
7057 "B<#include E<lt>unistd.hE<gt>>\n"
7061 #: build/C/man2/mknod.2:25
7064 "B<int mknod(const char *>I<pathname>B<, mode_t >I<mode>B<, dev_t "
7069 #: build/C/man2/mknod.2:30 build/C/man3/syslog.3:55
7070 msgid "Feature Test Macro Requirements for glibc (see B<feature_test_macros>(7)):"
7074 #: build/C/man2/mknod.2:33
7079 #: build/C/man2/mknod.2:37
7081 "_BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\\ E<gt>=\\ 500 || "
7082 "_XOPEN_SOURCE\\ &&\\ _XOPEN_SOURCE_EXTENDED"
7086 #: build/C/man2/mknod.2:49
7088 "The system call B<mknod>() creates a file system node (file, device special "
7089 "file or named pipe) named I<pathname>, with attributes specified by I<mode> "
7094 #: build/C/man2/mknod.2:56
7096 "The I<mode> argument specifies both the permissions to use and the type of "
7097 "node to be created. It should be a combination (using bitwise OR) of one of "
7098 "the file types listed below and the permissions for the new node."
7102 #: build/C/man2/mknod.2:61
7104 "The permissions are modified by the process's I<umask> in the usual way: the "
7105 "permissions of the created node are I<(mode & ~umask)>."
7108 #. (S_IFSOCK since Linux 1.2.4)
7110 #: build/C/man2/mknod.2:75
7112 "The file type must be one of B<S_IFREG>, B<S_IFCHR>, B<S_IFBLK>, B<S_IFIFO> "
7113 "or B<S_IFSOCK> to specify a regular file (which will be created empty), "
7114 "character special file, block special file, FIFO (named pipe), or UNIX "
7115 "domain socket, respectively. (Zero file type is equivalent to type "
7120 #: build/C/man2/mknod.2:88
7122 "If the file type is B<S_IFCHR> or B<S_IFBLK> then I<dev> specifies the major "
7123 "and minor numbers of the newly created device special file (B<makedev>(3) "
7124 "may be useful to build the value for I<dev>); otherwise it is ignored."
7128 #: build/C/man2/mknod.2:94
7130 "If I<pathname> already exists, or is a symbolic link, this call fails with "
7131 "an B<EEXIST> error."
7135 #: build/C/man2/mknod.2:101
7137 "The newly created node will be owned by the effective user ID of the "
7138 "process. If the directory containing the node has the set-group-ID bit set, "
7139 "or if the file system is mounted with BSD group semantics, the new node will "
7140 "inherit the group ownership from its parent directory; otherwise it will be "
7141 "owned by the effective group ID of the process."
7145 #: build/C/man2/mknod.2:106
7147 "B<mknod>() returns zero on success, or -1 if an error occurred (in which "
7148 "case, I<errno> is set appropriately)."
7152 #: build/C/man2/mknod.2:115
7154 "The parent directory does not allow write permission to the process, or one "
7155 "of the directories in the path prefix of I<pathname> did not allow search "
7156 "permission. (See also B<path_resolution>(7).)"
7160 #: build/C/man2/mknod.2:126 build/C/man4/st.4:838
7166 #: build/C/man2/mknod.2:129
7167 msgid "I<pathname> points outside your accessible address space."
7171 #: build/C/man2/mknod.2:134
7173 "I<mode> requested creation of something other than a regular file, device "
7174 "special file, FIFO or socket."
7178 #: build/C/man2/mknod.2:134
7184 #: build/C/man2/mknod.2:138
7185 msgid "Too many symbolic links were encountered in resolving I<pathname>."
7189 #: build/C/man2/mknod.2:141
7190 msgid "I<pathname> was too long."
7194 #: build/C/man2/mknod.2:146 build/C/man4/st.4:850
7200 #: build/C/man2/mknod.2:149
7201 msgid "Insufficient kernel memory was available."
7205 #: build/C/man2/mknod.2:154
7206 msgid "The device containing I<pathname> has no room for the new node."
7209 #. For UNIX domain sockets and regular files, EPERM is only returned in
7210 #. Linux 2.2 and earlier; in Linux 2.4 and later, unprivileged can
7211 #. use mknod() to make these files.
7213 #: build/C/man2/mknod.2:173
7215 "I<mode> requested creation of something other than a regular file, FIFO "
7216 "(named pipe), or UNIX domain socket, and the caller is not privileged "
7217 "(Linux: does not have the B<CAP_MKNOD> capability); also returned if the "
7218 "file system containing I<pathname> does not support the type of node "
7223 #: build/C/man2/mknod.2:177
7224 msgid "I<pathname> refers to a file on a read-only file system."
7227 #. The Linux version differs from the SVr4 version in that it
7228 #. does not require root permission to create pipes, also in that no
7229 #. EMULTIHOP, ENOLINK, or EINTR error is documented.
7231 #: build/C/man2/mknod.2:182
7232 msgid "SVr4, 4.4BSD, POSIX.1-2001 (but see below)."
7236 #: build/C/man2/mknod.2:200
7238 "POSIX.1-2001 says: \"The only portable use of B<mknod>() is to create a "
7239 "FIFO-special file. If I<mode> is not B<S_IFIFO> or I<dev> is not 0, the "
7240 "behavior of B<mknod>() is unspecified.\" However, nowadays one should never "
7241 "use B<mknod>() for this purpose; one should use B<mkfifo>(3), a function "
7242 "especially defined for this purpose."
7245 #. and one should make UNIX domain sockets with socket(2) and bind(2).
7247 #: build/C/man2/mknod.2:205
7249 "Under Linux, this call cannot be used to create directories. One should "
7250 "make directories with B<mkdir>(2)."
7254 #: build/C/man2/mknod.2:209
7256 "There are many infelicities in the protocol underlying NFS. Some of these "
7257 "affect B<mknod>()."
7261 #: build/C/man2/mknod.2:223
7263 "B<chmod>(2), B<chown>(2), B<fcntl>(2), B<mkdir>(2), B<mknodat>(2), "
7264 "B<mount>(2), B<socket>(2), B<stat>(2), B<umask>(2), B<unlink>(2), "
7265 "B<makedev>(3), B<mkfifo>(3), B<path_resolution>(7)"
7269 #: build/C/man4/mouse.4:26
7275 #: build/C/man4/mouse.4:26
7281 #: build/C/man4/mouse.4:29
7282 msgid "mouse - serial mouse interface"
7286 #: build/C/man4/mouse.4:33
7288 "Serial mice are connected to a serial RS232/V24 dialout line, see B<ttyS>(4) "
7289 "for a description."
7293 #: build/C/man4/mouse.4:34
7295 msgid "Introduction"
7299 #: build/C/man4/mouse.4:36
7300 msgid "The pinout of the usual 9 pin plug as used for serial mice is:"
7304 #: build/C/man4/mouse.4:39
7306 msgid "pin\tname\tused for\n"
7310 #: build/C/man4/mouse.4:40
7312 msgid "2\tRX\tData\n"
7316 #: build/C/man4/mouse.4:41
7318 msgid "3\tTX\t-12 V, Imax = 10 mA\n"
7322 #: build/C/man4/mouse.4:42
7324 msgid "4\tDTR\t+12 V, Imax = 10 mA\n"
7328 #: build/C/man4/mouse.4:43
7330 msgid "7\tRTS\t+12 V, Imax = 10 mA\n"
7334 #: build/C/man4/mouse.4:44
7336 msgid "5\tGND\tGround\n"
7340 #: build/C/man4/mouse.4:48
7341 msgid "This is the specification, in fact 9 V suffices with most mice."
7345 #: build/C/man4/mouse.4:54
7347 "The mouse driver can recognize a mouse by dropping RTS to low and raising it "
7348 "again. About 14 ms later the mouse will send 0x4D (\\(aqM\\(aq) on the data "
7349 "line. After a further 63 ms, a Microsoft-compatible 3-button mouse will "
7350 "send 0x33 (\\(aq3\\(aq)."
7354 #: build/C/man4/mouse.4:62
7356 "The relative mouse movement is sent as I<dx> (positive means right) and "
7357 "I<dy> (positive means down). Various mice can operate at different speeds. "
7358 "To select speeds, cycle through the speeds 9600, 4800, 2400 and 1200 bit/s, "
7359 "each time writing the two characters from the table below and waiting 0.1 "
7360 "seconds. The following table shows available speeds and the strings that "
7365 #: build/C/man4/mouse.4:65
7367 msgid "bit/s\tstring\n"
7371 #: build/C/man4/mouse.4:66
7377 #: build/C/man4/mouse.4:67
7383 #: build/C/man4/mouse.4:68
7389 #: build/C/man4/mouse.4:69
7395 #: build/C/man4/mouse.4:73
7396 msgid "The first byte of a data packet can be used to synchronization purposes."
7400 #: build/C/man4/mouse.4:73
7402 msgid "Microsoft protocol"
7406 #: build/C/man4/mouse.4:80
7408 "The B<Microsoft> protocol uses 1 start bit, 7 data bits, no parity and one "
7409 "stop bit at the speed of 1200 bits/sec. Data is sent to RxD in 3-byte "
7410 "packets. The I<dx> and I<dy> movements are sent as two's-complement, I<lb> "
7411 "(I<rb>) are set when the left (right) button is pressed:"
7415 #: build/C/man4/mouse.4:83
7417 msgid "byte\td6\td5\td4\td3\td2\td1\td0\n"
7421 #: build/C/man4/mouse.4:84
7423 msgid "1\t1\tlb\trb\tdy7\tdy6\tdx7\tdx6\n"
7427 #: build/C/man4/mouse.4:85
7429 msgid "2\t0\tdx5\tdx4\tdx3\tdx2\tdx1\tdx0\n"
7433 #: build/C/man4/mouse.4:86
7435 msgid "3\t0\tdy5\tdy4\tdy3\tdy2\tdy1\tdy0\n"
7439 #: build/C/man4/mouse.4:88
7441 msgid "3-button Microsoft protocol"
7445 #: build/C/man4/mouse.4:97
7447 "Original Microsoft mice only have two buttons. However, there are some "
7448 "three button mice which also use the Microsoft protocol. Pressing or "
7449 "releasing the middle button is reported by sending a packet with zero "
7450 "movement and no buttons pressed. (Thus, unlike for the other two buttons, "
7451 "the status of the middle button is not reported in each packet.)"
7455 #: build/C/man4/mouse.4:97
7457 msgid "Logitech protocol"
7461 #: build/C/man4/mouse.4:106
7463 "Logitech serial 3-button mice use a different extension of the Microsoft "
7464 "protocol: when the middle button is up, the above 3-byte packet is sent. "
7465 "When the middle button is down a 4-byte packet is sent, where the 4th byte "
7466 "has value 0x20 (or at least has the 0x20 bit set). In particular, a press "
7467 "of the middle button is reported as 0,0,0,0x20 when no other buttons are "
7472 #: build/C/man4/mouse.4:106
7474 msgid "Mousesystems protocol"
7478 #: build/C/man4/mouse.4:116
7480 "The B<Mousesystems> protocol uses 1 start bit, 8 data bits, no parity and "
7481 "two stop bits at the speed of 1200 bits/sec. Data is sent to RxD in 5-byte "
7482 "packets. I<dx> is sent as the sum of the two two's-complement values, I<dy> "
7483 "is send as negated sum of the two two's-complement values. I<lb> (I<mb>, "
7484 "I<rb>) are cleared when the left (middle, right) button is pressed:"
7488 #: build/C/man4/mouse.4:119 build/C/man4/mouse.4:144
7490 msgid "byte\td7\td6\td5\td4\td3\td2\td1\td0\n"
7494 #: build/C/man4/mouse.4:120
7496 msgid "1\t1\t0\t0\t0\t0\tlb\tmb\trb\n"
7500 #: build/C/man4/mouse.4:121
7502 msgid "2\t0\tdxa6\tdxa5\tdxa4\tdxa3\tdxa2\tdxa1\tdxa0\n"
7506 #: build/C/man4/mouse.4:122
7508 msgid "3\t0\tdya6\tdya5\tdya4\tdya3\tdya2\tdya1\tdya0\n"
7512 #: build/C/man4/mouse.4:123
7514 msgid "4\t0\tdxb6\tdxb5\tdxb4\tdxb3\tdxb2\tdxb1\tdxb0\n"
7518 #: build/C/man4/mouse.4:124
7520 msgid "5\t0\tdyb6\tdyb5\tdyb4\tdyb3\tdyb2\tdyb1\tdyb0\n"
7524 #: build/C/man4/mouse.4:129
7526 "Bytes 4 and 5 describe the change that occurred since bytes 2 and 3 were "
7531 #: build/C/man4/mouse.4:129
7533 msgid "Sun protocol"
7537 #: build/C/man4/mouse.4:132
7539 "The B<Sun> protocol is the 3-byte version of the above 5-byte Mousesystems "
7540 "protocol: the last two bytes are not sent."
7544 #: build/C/man4/mouse.4:132
7550 #: build/C/man4/mouse.4:141
7552 "The B<MM> protocol uses 1 start bit, 8 data bits, odd parity and one stop "
7553 "bit at the speed of 1200 bits/sec. Data is sent to RxD in 3-byte packets. "
7554 "I<dx> and I<dy> are sent as single signed values, the sign bit indicating a "
7555 "negative value. I<lb> (I<mb>, I<rb>) are set when the left (middle, right) "
7556 "button is pressed:"
7560 #: build/C/man4/mouse.4:145
7562 msgid "1\t1\t0\t0\tdxs\tdys\tlb\tmb\trb\n"
7566 #: build/C/man4/mouse.4:146
7568 msgid "2\t0\tdx6\tdx5\tdx4\tdx3\tdx2\tdx1\tdx0\n"
7572 #: build/C/man4/mouse.4:147
7574 msgid "3\t0\tdy6\tdy5\tdy4\tdy3\tdy2\tdy1\tdy0\n"
7578 #: build/C/man4/mouse.4:150
7580 msgid "I</dev/mouse>"
7584 #: build/C/man4/mouse.4:153
7585 msgid "A commonly used symlink pointing to a mouse device."
7589 #: build/C/man4/mouse.4:156
7590 msgid "B<ttyS>(4), B<gpm>(8)"
7594 #: build/C/man4/msr.4:26
7600 #: build/C/man4/msr.4:29
7601 msgid "msr - x86 CPU MSR access device"
7605 #: build/C/man4/msr.4:36
7607 "I</dev/cpu/CPUNUM/msr> provides an interface to read and write the "
7608 "model-specific registers (MSRs) of an x86 CPU. I<CPUNUM> is the number of "
7609 "the CPU to access as listed in I</proc/cpuinfo>."
7613 #: build/C/man4/msr.4:42
7615 "The register access is done by opening the file and seeking to the MSR "
7616 "number as offset in the file, and then reading or writing in chunks of 8 "
7617 "bytes. An I/O transfer of more than 8 bytes means multiple reads or writes "
7618 "of the same register."
7622 #: build/C/man4/msr.4:47
7624 "This file is protected so that it can only be read and written by the user "
7625 "I<root>, or members of the group I<root>."
7629 #: build/C/man4/msr.4:53
7631 "The I<msr> driver is not auto-loaded. On modular kernels you might need to "
7632 "use the following command to load it explicitly before use:"
7636 #: build/C/man4/msr.4:55
7638 msgid " $ I<modprobe msr>\n"
7642 #: build/C/man4/msr.4:59
7644 "Intel Corporation Intel 64 and IA-32 Architectures Software Developer's "
7645 "Manual Volume 3B Appendix B, for an overview of the Intel CPU MSRs."
7649 #: build/C/man4/null.4:26
7655 #: build/C/man4/null.4:26
7661 #: build/C/man4/null.4:29
7662 msgid "null, zero - data sink"
7666 #: build/C/man4/null.4:31
7667 msgid "Data written to a B<null> or B<zero> special file is discarded."
7671 #: build/C/man4/null.4:36
7673 "Reads from the B<null> special file always return end of file (i.e., "
7674 "B<read>(2) returns 0), whereas reads from B<zero> always return bytes "
7675 "containing zero (\\e0 characters)."
7679 #: build/C/man4/null.4:38
7680 msgid "B<null> and B<zero> are typically created by:"
7684 #: build/C/man4/null.4:41
7685 msgid "mknod -m 666 /dev/null c 1 3"
7689 #: build/C/man4/null.4:43
7690 msgid "mknod -m 666 /dev/zero c 1 5"
7694 #: build/C/man4/null.4:45
7695 msgid "chown root:root /dev/null /dev/zero"
7699 #: build/C/man4/null.4:48
7700 msgid "I</dev/null>"
7704 #: build/C/man4/null.4:50
7705 msgid "I</dev/zero>"
7709 #: build/C/man4/null.4:53
7711 "If these devices are not writable and readable for all users, many programs "
7712 "will act strangely."
7716 #: build/C/man4/null.4:57
7717 msgid "B<chown>(1), B<mknod>(1), B<full>(4)"
7721 #: build/C/man7/pipe.7:25
7727 #: build/C/man7/pipe.7:25
7733 #: build/C/man7/pipe.7:28
7734 msgid "pipe - overview of pipes and FIFOs"
7738 #: build/C/man7/pipe.7:37
7740 "Pipes and FIFOs (also known as named pipes) provide a unidirectional "
7741 "interprocess communication channel. A pipe has a I<read end> and a I<write "
7742 "end>. Data written to the write end of a pipe can be read from the read end "
7747 #: build/C/man7/pipe.7:47
7749 "A pipe is created using B<pipe>(2), which creates a new pipe and returns two "
7750 "file descriptors, one referring to the read end of the pipe, the other "
7751 "referring to the write end. Pipes can be used to create a communication "
7752 "channel between related processes; see B<pipe>(2) for an example."
7756 #: build/C/man7/pipe.7:66
7758 "A FIFO (short for First In First Out) has a name within the file system "
7759 "(created using B<mkfifo>(3)), and is opened using B<open>(2). Any process "
7760 "may open a FIFO, assuming the file permissions allow it. The read end is "
7761 "opened using the B<O_RDONLY> flag; the write end is opened using the "
7762 "B<O_WRONLY> flag. See B<fifo>(7) for further details. I<Note>: although "
7763 "FIFOs have a pathname in the file system, I/O on FIFOs does not involve "
7764 "operations on the underlying device (if there is one)."
7768 #: build/C/man7/pipe.7:66
7770 msgid "I/O on pipes and FIFOs"
7774 #: build/C/man7/pipe.7:71
7776 "The only difference between pipes and FIFOs is the manner in which they are "
7777 "created and opened. Once these tasks have been accomplished, I/O on pipes "
7778 "and FIFOs has exactly the same semantics."
7782 #: build/C/man7/pipe.7:85
7784 "If a process attempts to read from an empty pipe, then B<read>(2) will "
7785 "block until data is available. If a process attempts to write to a full "
7786 "pipe (see below), then B<write>(2) blocks until sufficient data has been "
7787 "read from the pipe to allow the write to complete. Nonblocking I/O is "
7788 "possible by using the B<fcntl>(2) B<F_SETFL> operation to enable the "
7789 "B<O_NONBLOCK> open file status flag."
7793 #: build/C/man7/pipe.7:89
7795 "The communication channel provided by a pipe is a I<byte stream>: there is "
7796 "no concept of message boundaries."
7800 #: build/C/man7/pipe.7:116
7802 "If all file descriptors referring to the write end of a pipe have been "
7803 "closed, then an attempt to B<read>(2) from the pipe will see end-of-file "
7804 "(B<read>(2) will return 0). If all file descriptors referring to the read "
7805 "end of a pipe have been closed, then a B<write>(2) will cause a B<SIGPIPE> "
7806 "signal to be generated for the calling process. If the calling process is "
7807 "ignoring this signal, then B<write>(2) fails with the error B<EPIPE>. An "
7808 "application that uses B<pipe>(2) and B<fork>(2) should use suitable "
7809 "B<close>(2) calls to close unnecessary duplicate file descriptors; this "
7810 "ensures that end-of-file and B<SIGPIPE>/B<EPIPE> are delivered when "
7815 #: build/C/man7/pipe.7:120
7816 msgid "It is not possible to apply B<lseek>(2) to a pipe."
7820 #: build/C/man7/pipe.7:120
7822 msgid "Pipe capacity"
7826 #: build/C/man7/pipe.7:132
7828 "A pipe has a limited capacity. If the pipe is full, then a B<write>(2) "
7829 "will block or fail, depending on whether the B<O_NONBLOCK> flag is set (see "
7830 "below). Different implementations have different limits for the pipe "
7831 "capacity. Applications should not rely on a particular capacity: an "
7832 "application should be designed so that a reading process consumes data as "
7833 "soon as it is available, so that a writing process does not remain blocked."
7837 #: build/C/man7/pipe.7:136
7839 "In Linux versions before 2.6.11, the capacity of a pipe was the same as the "
7840 "system page size (e.g., 4096 bytes on i386). Since Linux 2.6.11, the pipe "
7841 "capacity is 65536 bytes."
7845 #: build/C/man7/pipe.7:136
7851 #: build/C/man7/pipe.7:158
7853 "POSIX.1-2001 says that B<write>(2)s of less than B<PIPE_BUF> bytes must be "
7854 "atomic: the output data is written to the pipe as a contiguous sequence. "
7855 "Writes of more than B<PIPE_BUF> bytes may be nonatomic: the kernel may "
7856 "interleave the data with data written by other processes. POSIX.1-2001 "
7857 "requires B<PIPE_BUF> to be at least 512 bytes. (On Linux, B<PIPE_BUF> is "
7858 "4096 bytes.) The precise semantics depend on whether the file descriptor is "
7859 "nonblocking (B<O_NONBLOCK>), whether there are multiple writers to the pipe, "
7860 "and on I<n>, the number of bytes to be written:"
7864 #: build/C/man7/pipe.7:158
7866 msgid "B<O_NONBLOCK> disabled, I<n> E<lt>= B<PIPE_BUF>"
7870 #: build/C/man7/pipe.7:167
7872 "All I<n> bytes are written atomically; B<write>(2) may block if there is "
7873 "not room for I<n> bytes to be written immediately"
7877 #: build/C/man7/pipe.7:167
7879 msgid "B<O_NONBLOCK> enabled, I<n> E<lt>= B<PIPE_BUF>"
7883 #: build/C/man7/pipe.7:181
7885 "If there is room to write I<n> bytes to the pipe, then B<write>(2) succeeds "
7886 "immediately, writing all I<n> bytes; otherwise B<write>(2) fails, with "
7887 "I<errno> set to B<EAGAIN>."
7891 #: build/C/man7/pipe.7:181
7893 msgid "B<O_NONBLOCK> disabled, I<n> E<gt> B<PIPE_BUF>"
7897 #: build/C/man7/pipe.7:193
7899 "The write is nonatomic: the data given to B<write>(2) may be interleaved "
7900 "with B<write>(2)s by other process; the B<write>(2) blocks until I<n> bytes "
7901 "have been written."
7905 #: build/C/man7/pipe.7:193
7907 msgid "B<O_NONBLOCK> enabled, I<n> E<gt> B<PIPE_BUF>"
7911 #: build/C/man7/pipe.7:208
7913 "If the pipe is full, then B<write>(2) fails, with I<errno> set to "
7914 "B<EAGAIN>. Otherwise, from 1 to I<n> bytes may be written (i.e., a "
7915 "\"partial write\" may occur; the caller should check the return value from "
7916 "B<write>(2) to see how many bytes were actually written), and these bytes "
7917 "may be interleaved with writes by other processes."
7921 #: build/C/man7/pipe.7:208
7923 msgid "Open file status flags"
7927 #: build/C/man7/pipe.7:214
7929 "The only open file status flags that can be meaningfully applied to a pipe "
7930 "or FIFO are B<O_NONBLOCK> and B<O_ASYNC>."
7934 #: build/C/man7/pipe.7:226
7936 "Setting the B<O_ASYNC> flag for the read end of a pipe causes a signal "
7937 "(B<SIGIO> by default) to be generated when new input becomes available on "
7938 "the pipe (see B<fcntl>(2) for details). On Linux, B<O_ASYNC> is supported "
7939 "for pipes and FIFOs only since kernel 2.6."
7943 #: build/C/man7/pipe.7:226
7945 msgid "Portability notes"
7949 #: build/C/man7/pipe.7:232
7951 "On some systems (but not Linux), pipes are bidirectional: data can be "
7952 "transmitted in both directions between the pipe ends. According to "
7953 "POSIX.1-2001, pipes only need to be unidirectional. Portable applications "
7954 "should avoid reliance on bidirectional pipe semantics."
7958 #: build/C/man7/pipe.7:244
7960 "B<dup>(2), B<fcntl>(2), B<open>(2), B<pipe>(2), B<poll>(2), B<select>(2), "
7961 "B<socketpair>(2), B<stat>(2), B<mkfifo>(3), B<epoll>(7), B<fifo>(7)"
7965 #: build/C/man4/ram.4:26
7971 #: build/C/man4/ram.4:29
7972 msgid "ram - ram disk device"
7976 #: build/C/man4/ram.4:31
7977 msgid "The I<ram> device is a block device to access the ram disk in raw mode."
7981 #: build/C/man4/ram.4:36
7982 msgid "mknod -m 660 /dev/ram b 1 1"
7986 #: build/C/man4/ram.4:38
7987 msgid "chown root:disk /dev/ram"
7991 #: build/C/man4/ram.4:41
7996 #: build/C/man4/ram.4:45
7997 msgid "B<chown>(1), B<mknod>(1), B<mount>(8)"
8001 #: build/C/man4/random.4:19
8007 #: build/C/man4/random.4:19 build/C/man3/stdarg.3:43
8013 #: build/C/man4/random.4:22
8014 msgid "random, urandom - kernel random number source devices"
8018 #: build/C/man4/random.4:24
8019 msgid "#include E<lt>linux/random.hE<gt>"
8023 #: build/C/man4/random.4:26
8024 msgid "B<int ioctl(>I<fd>B<, RND>I<request>B<, >I<param>B<);>"
8028 #: build/C/man4/random.4:33
8030 "The character special files I</dev/random> and I</dev/urandom> (present "
8031 "since Linux 1.3.30) provide an interface to the kernel's random number "
8032 "generator. File I</dev/random> has major device number 1 and minor device "
8033 "number 8. File I</dev/urandom> has major device number 1 and minor device "
8038 #: build/C/man4/random.4:39
8040 "The random number generator gathers environmental noise from device drivers "
8041 "and other sources into an entropy pool. The generator also keeps an "
8042 "estimate of the number of bits of noise in the entropy pool. From this "
8043 "entropy pool random numbers are created."
8047 #: build/C/man4/random.4:47
8049 "When read, the I</dev/random> device will only return random bytes within "
8050 "the estimated number of bits of noise in the entropy pool. I</dev/random> "
8051 "should be suitable for uses that need very high quality randomness such as "
8052 "one-time pad or key generation. When the entropy pool is empty, reads from "
8053 "I</dev/random> will block until additional environmental noise is gathered."
8057 #: build/C/man4/random.4:58
8059 "A read from the I</dev/urandom> device will not block waiting for more "
8060 "entropy. As a result, if there is not sufficient entropy in the entropy "
8061 "pool, the returned values are theoretically vulnerable to a cryptographic "
8062 "attack on the algorithms used by the driver. Knowledge of how to do this is "
8063 "not available in the current unclassified literature, but it is "
8064 "theoretically possible that such an attack may exist. If this is a concern "
8065 "in your application, use I</dev/random> instead."
8069 #: build/C/man4/random.4:65
8071 "Writing to I</dev/random> or I</dev/urandom> will update the entropy pool "
8072 "with the data written, but this will not result in a higher entropy count. "
8073 "This means that it will impact the contents read from both files, but it "
8074 "will not make reads from I</dev/random> faster."
8078 #: build/C/man4/random.4:74
8080 "If you are unsure about whether you should use I</dev/random> or "
8081 "I</dev/urandom>, then probably you want to use the latter. As a general "
8082 "rule, I</dev/urandom> should be used for everything except long-lived "
8087 #: build/C/man4/random.4:86
8089 "If a seed file is saved across reboots as recommended below (all major Linux "
8090 "distributions have done this since 2000 at least), the output is "
8091 "cryptographically secure against attackers without local root access as soon "
8092 "as it is reloaded in the boot sequence, and perfectly adequate for network "
8093 "encryption session keys. Since reads from I</dev/random> may block, users "
8094 "will usually want to open it in nonblocking mode (or perform a read with "
8095 "timeout), and provide some sort of user notification if the desired entropy "
8096 "is not immediately available."
8100 #: build/C/man4/random.4:99
8102 "The kernel random-number generator is designed to produce a small amount of "
8103 "high-quality seed material to seed a cryptographic pseudo-random number "
8104 "generator (CPRNG). It is designed for security, not speed, and is poorly "
8105 "suited to generating large amounts of random data. Users should be very "
8106 "economical in the amount of seed material that they read from "
8107 "I</dev/urandom> (and I</dev/random>); unnecessarily reading large quantities "
8108 "of data from this device will have a negative impact on other users of the "
8113 #: build/C/man4/random.4:107
8115 "The amount of seed material required to generate a cryptographic key equals "
8116 "the effective key size of the key. For example, a 3072-bit RSA or "
8117 "Diffie-Hellman private key has an effective key size of 128 bits (it "
8118 "requires about 2^128 operations to break) so a key generator only needs 128 "
8119 "bits (16 bytes) of seed material from I</dev/random>."
8123 #: build/C/man4/random.4:116
8125 "While some safety margin above that minimum is reasonable, as a guard "
8126 "against flaws in the CPRNG algorithm, no cryptographic primitive available "
8127 "today can hope to promise more than 256 bits of security, so if any program "
8128 "reads more than 256 bits (32 bytes) from the kernel random pool per "
8129 "invocation, or per reasonable reseed interval (not less than one minute), "
8130 "that should be taken as a sign that its cryptography is I<not> skillfully "
8135 #: build/C/man4/random.4:116
8137 msgid "Configuration"
8141 #: build/C/man4/random.4:120
8143 "If your system does not have I</dev/random> and I</dev/urandom> created "
8144 "already, they can be created with the following commands:"
8148 #: build/C/man4/random.4:125
8151 " mknod -m 644 /dev/random c 1 8\n"
8152 " mknod -m 644 /dev/urandom c 1 9\n"
8153 " chown root:root /dev/random /dev/urandom\n"
8157 #: build/C/man4/random.4:135
8159 "When a Linux system starts up without much operator interaction, the entropy "
8160 "pool may be in a fairly predictable state. This reduces the actual amount "
8161 "of noise in the entropy pool below the estimate. In order to counteract "
8162 "this effect, it helps to carry entropy pool information across shut-downs "
8163 "and start-ups. To do this, add the following lines to an appropriate script "
8164 "which is run during the Linux system start-up sequence:"
8168 #: build/C/man4/random.4:150
8171 " echo \"Initializing random number generator...\"\n"
8172 " random_seed=/var/run/random-seed\n"
8173 " # Carry a random seed from start-up to start-up\n"
8174 " # Load and then save the whole entropy pool\n"
8175 " if [ -f $random_seed ]; then\n"
8176 " cat $random_seed E<gt>/dev/urandom\n"
8178 " touch $random_seed\n"
8180 " chmod 600 $random_seed\n"
8181 " poolfile=/proc/sys/kernel/random/poolsize\n"
8182 " [ -r $poolfile ] && bytes=\\`cat $poolfile\\` || bytes=512\n"
8183 " dd if=/dev/urandom of=$random_seed count=1 bs=$bytes\n"
8187 #: build/C/man4/random.4:154
8189 "Also, add the following lines in an appropriate script which is run during "
8190 "the Linux system shutdown:"
8194 #: build/C/man4/random.4:165
8197 " # Carry a random seed from shut-down to start-up\n"
8198 " # Save the whole entropy pool\n"
8199 " echo \"Saving random seed...\"\n"
8200 " random_seed=/var/run/random-seed\n"
8201 " touch $random_seed\n"
8202 " chmod 600 $random_seed\n"
8203 " poolfile=/proc/sys/kernel/random/poolsize\n"
8204 " [ -r $poolfile ] && bytes=\\`cat $poolfile\\` || bytes=512\n"
8205 " dd if=/dev/urandom of=$random_seed count=1 bs=$bytes\n"
8209 #: build/C/man4/random.4:166
8211 msgid "/proc Interface"
8215 #: build/C/man4/random.4:172
8217 "The files in the directory I</proc/sys/kernel/random> (present since 2.3.16) "
8218 "provide an additional interface to the I</dev/random> device."
8222 #: build/C/man4/random.4:178
8224 "The read-only file I<entropy_avail> gives the available entropy. Normally, "
8225 "this will be 4096 (bits), a full entropy pool."
8229 #: build/C/man4/random.4:183
8231 "The file I<poolsize> gives the size of the entropy pool. The semantics of "
8232 "this file vary across kernel versions:"
8236 #: build/C/man4/random.4:184
8242 #: build/C/man4/random.4:191
8244 "This file gives the size of the entropy pool in I<bytes>. Normally, this "
8245 "file will have the value 512, but it is writable, and can be changed to any "
8246 "value for which an algorithm is available. The choices are 32, 64, 128, "
8247 "256, 512, 1024, or 2048."
8251 #: build/C/man4/random.4:191
8257 #: build/C/man4/random.4:196
8259 "This file is read-only, and gives the size of the entropy pool in I<bits>. "
8260 "It contains the value 4096."
8264 #: build/C/man4/random.4:214
8266 "The file I<read_wakeup_threshold> contains the number of bits of entropy "
8267 "required for waking up processes that sleep waiting for entropy from "
8268 "I</dev/random>. The default is 64. The file I<write_wakeup_threshold> "
8269 "contains the number of bits of entropy below which we wake up processes that "
8270 "do a B<select>(2) or B<poll>(2) for write access to I</dev/random>. These "
8271 "values can be changed by writing to the files."
8275 #: build/C/man4/random.4:222
8277 "The read-only files I<uuid> and I<boot_id> contain random strings like "
8278 "6fd5a44b-35f4-4ad4-a9b9-6b9be13e1fe9. The former is generated afresh for "
8279 "each read, the latter was generated once."
8283 #: build/C/man4/random.4:222
8285 msgid "ioctl(2) interface"
8289 #: build/C/man4/random.4:233
8291 "The following B<ioctl>(2) requests are defined on file descriptors "
8292 "connected to either I</dev/random> or I</dev/urandom>. All requests "
8293 "performed will interact with the input entropy pool impacting both "
8294 "I</dev/random> and I</dev/urandom>. The B<CAP_SYS_ADMIN> capability is "
8295 "required for all requests except B<RNDGETENTCNT>."
8299 #: build/C/man4/random.4:233
8301 msgid "B<RNDGETENTCNT>"
8305 #: build/C/man4/random.4:240
8307 "Retrieve the entropy count of the input pool, the contents will be the same "
8308 "as the I<entropy_avail> file under proc. The result will be stored in the "
8309 "int pointed to by the argument."
8313 #: build/C/man4/random.4:240
8315 msgid "B<RNDADDTOENTCNT>"
8319 #: build/C/man4/random.4:244
8321 "Increment or decrement the entropy count of the input pool by the value "
8322 "pointed to by the argument."
8326 #: build/C/man4/random.4:244
8328 msgid "B<RNDGETPOOL>"
8332 #: build/C/man4/random.4:247
8333 msgid "Removed in Linux 2.6.9."
8337 #: build/C/man4/random.4:247
8339 msgid "B<RNDADDENTROPY>"
8343 #: build/C/man4/random.4:255
8345 "Add some additional entropy to the input pool, incrementing the entropy "
8346 "count. This differs from writing to I</dev/random> or I</dev/urandom>, "
8347 "which only adds some data but does not increment the entropy count. The "
8348 "following structure is used:"
8352 #: build/C/man4/random.4:262
8355 " struct rand_pool_info {\n"
8356 " int entropy_count;\n"
8363 #: build/C/man4/random.4:271
8365 "Here I<entropy_count> is the value added to (or subtracted from) from the "
8366 "entropy count, and I<buf> is the buffer of size I<buf_size> which gets added "
8367 "to the entropy pool."
8371 #: build/C/man4/random.4:271
8373 msgid "B<RNDZAPENTCNT>, B<RNDCLEARPOOL>"
8377 #: build/C/man4/random.4:275
8379 "Zero the entropy count of all pools and add some system data (such as wall "
8380 "clock) to the pools."
8384 #: build/C/man4/random.4:277
8389 #. The kernel's random number generator was written by
8390 #. Theodore Ts'o (tytso@athena.mit.edu).
8392 #: build/C/man4/random.4:282
8393 msgid "/dev/urandom"
8397 #: build/C/man4/random.4:284
8402 #: build/C/man4/random.4:286
8403 msgid "RFC\\ 1750, \"Randomness Recommendations for Security\""
8407 #: build/C/man4/sd.4:26
8413 #: build/C/man4/sd.4:26
8419 #: build/C/man4/sd.4:29
8420 msgid "sd - driver for SCSI disk drives"
8424 #: build/C/man4/sd.4:33
8427 "B<#include E<lt>linux/hdreg.hE<gt> >/* for HDIO_GETGEO */\n"
8428 "B<#include E<lt>linux/fs.hE<gt> >/* for BLKGETSIZE and BLKRRPART "
8433 #: build/C/man4/sd.4:45
8435 "The block device name has the following form: B<sd>I<lp,> where I<l> is a "
8436 "letter denoting the physical drive, and I<p> is a number denoting the "
8437 "partition on that physical drive. Often, the partition number, I<p>, will "
8438 "be left off when the device corresponds to the whole drive."
8442 #: build/C/man4/sd.4:54
8444 "SCSI disks have a major device number of 8, and a minor device number of the "
8445 "form (16 * I<drive_number>) + I<partition_number>, where I<drive_number> is "
8446 "the number of the physical drive in order of detection, and "
8447 "I<partition_number> is as follows:"
8451 #: build/C/man4/sd.4:56
8452 msgid "partition 0 is the whole drive"
8456 #: build/C/man4/sd.4:58
8457 msgid "partitions 1-4 are the DOS \"primary\" partitions"
8461 #: build/C/man4/sd.4:60
8462 msgid "partitions 5-8 are the DOS \"extended\" (or \"logical\") partitions"
8466 #: build/C/man4/sd.4:68
8468 "For example, I</dev/sda> will have major 8, minor 0, and will refer to all "
8469 "of the first SCSI drive in the system; and I</dev/sdb3> will have major 8, "
8470 "minor 19, and will refer to the third DOS \"primary\" partition on the "
8471 "second SCSI drive in the system."
8475 #: build/C/man4/sd.4:71
8477 "At this time, only block devices are provided. Raw devices have not yet "
8482 #: build/C/man4/sd.4:75
8483 msgid "The following I<ioctl>s are provided:"
8487 #: build/C/man4/sd.4:75
8489 msgid "B<HDIO_GETGEO>"
8493 #: build/C/man4/sd.4:79
8494 msgid "Returns the BIOS disk parameters in the following structure:"
8498 #: build/C/man4/sd.4:88
8501 "struct hd_geometry {\n"
8502 " unsigned char heads;\n"
8503 " unsigned char sectors;\n"
8504 " unsigned short cylinders;\n"
8505 " unsigned long start;\n"
8510 #: build/C/man4/sd.4:94
8511 msgid "A pointer to this structure is passed as the B<ioctl>(2) parameter."
8515 #: build/C/man4/sd.4:109
8517 "The information returned in the parameter is the disk geometry of the drive "
8518 "I<as understood by DOS!> This geometry is I<not> the physical geometry of "
8519 "the drive. It is used when constructing the drive's partition table, "
8520 "however, and is needed for convenient operation of B<fdisk>(1), "
8521 "B<efdisk>(1), and B<lilo>(1). If the geometry information is not available, "
8522 "zero will be returned for all of the parameters."
8526 #: build/C/man4/sd.4:110
8528 msgid "B<BLKGETSIZE>"
8532 #: build/C/man4/sd.4:117
8534 "Returns the device size in sectors. The B<ioctl>(2) parameter should be a "
8535 "pointer to a I<long>."
8539 #: build/C/man4/sd.4:117
8541 msgid "B<BLKRRPART>"
8545 #: build/C/man4/sd.4:121
8546 msgid "Forces a reread of the SCSI disk partition tables. No parameter is needed."
8550 #: build/C/man4/sd.4:131
8552 "The SCSI B<ioctl>(2) operations are also supported. If the B<ioctl>(2) "
8553 "parameter is required, and it is NULL, then B<ioctl>(2) will fail with the "
8558 #: build/C/man4/sd.4:133
8559 msgid "/dev/sd[a-h]: the whole device"
8565 #: build/C/man4/sd.4:137
8566 msgid "/dev/sd[a-h][0-8]: individual block partitions"
8570 #: build/C/man3/setlogmask.3:25
8576 #: build/C/man3/setlogmask.3:25
8582 #: build/C/man3/setlogmask.3:28
8583 msgid "setlogmask - set log priority mask"
8587 #: build/C/man3/setlogmask.3:31
8589 msgid "B<#include E<lt>syslog.hE<gt>>\n"
8593 #: build/C/man3/setlogmask.3:33
8595 msgid "B<int setlogmask(int >I<mask>B<);>\n"
8599 #: build/C/man3/setlogmask.3:43
8601 "A process has a log priority mask that determines which calls to "
8602 "B<syslog>(3) may be logged. All other calls will be ignored. Logging is "
8603 "enabled for the priorities that have the corresponding bit set in I<mask>. "
8604 "The initial mask is such that logging is enabled for all priorities."
8608 #: build/C/man3/setlogmask.3:49
8610 "The B<setlogmask>() function sets this logmask for the calling process, and "
8611 "returns the previous mask. If the mask argument is 0, the current logmask "
8616 #: build/C/man3/setlogmask.3:63
8618 "The eight priorities are B<LOG_EMERG>, B<LOG_ALERT>, B<LOG_CRIT>, "
8619 "B<LOG_ERR>, B<LOG_WARNING>, B<LOG_NOTICE>, B<LOG_INFO>, and B<LOG_DEBUG>. "
8620 "The bit corresponding to a priority I<p> is B<LOG_MASK>(I<p>). Some systems "
8621 "also provide a macro B<LOG_UPTO>(I<p>) for the mask of all priorities in the "
8622 "above list up to and including I<p>."
8626 #: build/C/man3/setlogmask.3:65
8627 msgid "This function returns the previous log priority mask."
8631 #. The glibc logmask handling was broken in versions before glibc 2.1.1.
8633 #: build/C/man3/setlogmask.3:69
8638 #: build/C/man3/setlogmask.3:72
8639 msgid "POSIX.1-2001. Note that the description in POSIX.1-2001 is flawed."
8643 #: build/C/man3/setlogmask.3:76
8644 msgid "B<closelog>(3), B<openlog>(3), B<syslog>(3)"
8648 #: build/C/man4/sk98lin.4:27
8654 #: build/C/man4/sk98lin.4:30
8655 msgid "sk98lin - Marvell/SysKonnect Gigabit Ethernet driver v6.21"
8659 #: build/C/man4/sk98lin.4:62
8661 "B<insmod sk98lin.o> [B<Speed_A=>I<i,j,...>] [B<Speed_B=>I<i,j,...>] "
8662 "[B<AutoNeg_A=>I<i,j,...>] [B<AutoNeg_B=>I<i,j,...>] [B<DupCap_A=>I<i,j,...>] "
8663 "[B<DupCap_B=>I<i,j,...>] [B<FlowCtrl_A=>I<i,j,...>] "
8664 "[B<FlowCtrl_B=>I<i,j,...>] [B<Role_A=>I<i,j,...>] [B<Role_B=>I<i,j,...>] "
8665 "[B<ConType=>I<i,j,...>] [B<Moderation=>I<i,j,...>] "
8666 "[B<IntsPerSec=>I<i,j,...>] [B<PrefPort=>I<i,j,...>] [B<RlmtMode=>I<i,j,...>]"
8670 #: build/C/man4/sk98lin.4:67
8671 msgid "B<Note>: This obsolete driver was removed from the kernel in version 2.6.26."
8675 #: build/C/man4/sk98lin.4:74
8677 "B<sk98lin> is the Gigabit Ethernet driver for Marvell and SysKonnect network "
8678 "adapter cards. It supports SysKonnect SK-98xx/SK-95xx compliant Gigabit "
8679 "Ethernet Adapter and any Yukon compliant chipset."
8683 #: build/C/man4/sk98lin.4:81
8685 "When loading the driver using insmod, parameters for the network adapter "
8686 "cards might be stated as a sequence of comma separated commands. If for "
8687 "instance two network adapters are installed and AutoNegotiation on Port A of "
8688 "the first adapter should be ON, but on the Port A of the second adapter "
8689 "switched OFF, one must enter:"
8693 #: build/C/man4/sk98lin.4:83
8695 msgid " insmod sk98lin.o AutoNeg_A=On,Off\n"
8699 #: build/C/man4/sk98lin.4:98
8701 "After B<sk98lin> is bound to one or more adapter cards and the I</proc> file "
8702 "system is mounted on your system, a dedicated statistics file will be "
8703 "created in folder I</proc/net/sk98lin> for all ports of the installed "
8704 "network adapter cards. Those files are named I<eth[x]> whereas I<x> is the "
8705 "number of the interface that has been assigned to a dedicated port by the "
8710 #: build/C/man4/sk98lin.4:108
8712 "If loading is finished, any desired IP address can be assigned to the "
8713 "respective I<eth[x]> interface using the B<ifconfig>(8) command. This "
8714 "causes the adapter to connect to the Ethernet and to display a status "
8715 "message on the console saying \"ethx: network connection up using port y\" "
8716 "followed by the configured or detected connection parameters."
8720 #: build/C/man4/sk98lin.4:124
8722 "The B<sk98lin> also supports large frames (also called jumbo frames). Using "
8723 "jumbo frames can improve throughput tremendously when transferring large "
8724 "amounts of data. To enable large frames, the MTU (maximum transfer unit) "
8725 "size for an interface is to be set to a high value. The default MTU size is "
8726 "1500 and can be changed up to 9000 (bytes). Setting the MTU size can be "
8727 "done when assigning the IP address to the interface or later by using the "
8728 "B<ifconfig>(8) command with the mtu parameter. If for instance eth0 needs "
8729 "an IP address and a large frame MTU size, the following two commands might "
8734 #: build/C/man4/sk98lin.4:127
8737 " ifconfig eth0 10.1.1.1\n"
8738 " ifconfig eth0 mtu 9000\n"
8742 #: build/C/man4/sk98lin.4:129
8743 msgid "Those two commands might even be combined into one:"
8747 #: build/C/man4/sk98lin.4:131
8749 msgid " ifconfig eth0 10.1.1.1 mtu 9000\n"
8753 #: build/C/man4/sk98lin.4:144
8755 "Note that large frames can only be used if permitted by your network "
8756 "infrastructure. This means, that any switch being used in your Ethernet "
8757 "must also support large frames. Quite some switches support large frames, "
8758 "but need to be configured to do so. Most of the times, their default "
8759 "setting is to support only standard frames with an MTU size of 1500 "
8760 "(bytes). In addition to the switches inside the network, all network "
8761 "adapters that are to be used must also be enabled regarding jumbo frames. "
8762 "If an adapter is not set to receive large frames it will simply drop them."
8766 #: build/C/man4/sk98lin.4:148
8768 "Switching back to the standard Ethernet frame size can be done by using the "
8769 "B<ifconfig>(8) command again:"
8773 #: build/C/man4/sk98lin.4:150
8775 msgid " ifconfig eth0 mtu 1500\n"
8779 #: build/C/man4/sk98lin.4:156
8781 "The Marvell/SysKonnect Gigabit Ethernet driver for Linux is able to support "
8782 "VLAN and Link Aggregation according to IEEE standards 802.1, 802.1q, and "
8783 "802.3ad. Those features are only available after installation of open "
8784 "source modules which can be found on the Internet:"
8788 #: build/C/man4/sk98lin.4:161
8789 msgid "I<VLAN>: E<.UR http://www.candelatech.com\\:/~greear\\:/vlan.html> E<.UE>"
8793 #: build/C/man4/sk98lin.4:167
8794 msgid "I<Link> I<Aggregation>: E<.UR http://www.st.rim.or.jp\\:/~yumo> E<.UE>"
8798 #: build/C/man4/sk98lin.4:172
8800 "Note that Marvell/SysKonnect does not offer any support for these open "
8801 "source modules and does not take the responsibility for any kind of failures "
8802 "or problems arising when using these modules."
8806 #: build/C/man4/sk98lin.4:172 build/C/man4/wavelan.4:36
8812 #: build/C/man4/sk98lin.4:173
8814 msgid "B<Speed_A=>I<i,j,...>"
8818 #: build/C/man4/sk98lin.4:191
8820 "This parameter is used to set the speed capabilities of port A of an adapter "
8821 "card. It is only valid for Yukon copper adapters. Possible values are: "
8822 "I<10>, I<100>, I<1000> or I<Auto> whereas I<Auto> is the default. Usually, "
8823 "the speed is negotiated between the two ports during link establishment. If "
8824 "this fails, a port can be forced to a specific setting with this parameter."
8828 #: build/C/man4/sk98lin.4:191
8830 msgid "B<Speed_B=>I<i,j,...>"
8834 #: build/C/man4/sk98lin.4:209
8836 "This parameter is used to set the speed capabilities of port B of an adapter "
8837 "card. It is only valid for Yukon copper adapters. Possible values are: "
8838 "I<10>, I<100>, I<1000> or I<Auto> whereas I<Auto> is the default. Usually, "
8839 "the speed is negotiated between the two ports during link establishment. If "
8840 "this fails, a port can be forced to a specific setting with this parameter."
8844 #: build/C/man4/sk98lin.4:209
8846 msgid "B<AutoNeg_A=>I<i,j,...>"
8850 #: build/C/man4/sk98lin.4:224
8852 "Enables or disables the use of autonegotiation of port A of an adapter "
8853 "card. Possible values are: I<On>, I<Off> or I<Sense> whereas I<On> is the "
8854 "default. The I<Sense> mode automatically detects whether the link partner "
8855 "supports auto-negotiation or not."
8859 #: build/C/man4/sk98lin.4:224
8861 msgid "B<AutoNeg_B=>I<i,j,...>"
8865 #: build/C/man4/sk98lin.4:239
8867 "Enables or disables the use of autonegotiation of port B of an adapter "
8868 "card. Possible values are: I<On>, I<Off> or I<Sense> whereas I<On> is the "
8869 "default. The I<Sense> mode automatically detects whether the link partner "
8870 "supports auto-negotiation or not."
8874 #: build/C/man4/sk98lin.4:239
8876 msgid "B<DupCap_A=>I<i,j,...>"
8880 #: build/C/man4/sk98lin.4:270
8882 "This parameter indicates the duplex mode to be used for port A of an adapter "
8883 "card. Possible values are: I<Half>, I<Full> or I<Both> whereas I<Both> is "
8884 "the default. This parameter is only relevant if AutoNeg_A of port A is not "
8885 "set to I<Sense>. If AutoNeg_A is set to I<On>, all three values of DupCap_A "
8886 "( I<Half>, I<Full> or I<Both>) might be stated. If AutoNeg_A is set to "
8887 "I<Off>, only DupCap_A values I<Full> and I<Half> are allowed. This DupCap_A "
8888 "parameter is useful if your link partner does not support all possible "
8889 "duplex combinations."
8893 #: build/C/man4/sk98lin.4:270
8895 msgid "B<DupCap_B=>I<i,j,...>"
8899 #: build/C/man4/sk98lin.4:301
8901 "This parameter indicates the duplex mode to be used for port B of an adapter "
8902 "card. Possible values are: I<Half>, I<Full> or I<Both> whereas I<Both> is "
8903 "the default. This parameter is only relevant if AutoNeg_B of port B is not "
8904 "set to I<Sense>. If AutoNeg_B is set to I<On>, all three values of DupCap_B "
8905 "( I<Half>, I<Full> or I<Both>) might be stated. If AutoNeg_B is set to "
8906 "I<Off>, only DupCap_B values I<Full> and I<Half> are allowed. This DupCap_B "
8907 "parameter is useful if your link partner does not support all possible "
8908 "duplex combinations."
8912 #: build/C/man4/sk98lin.4:301
8914 msgid "B<FlowCtrl_A=>I<i,j,...>"
8918 #: build/C/man4/sk98lin.4:315 build/C/man4/sk98lin.4:349
8920 "This parameter can be used to set the flow control capabilities the port "
8921 "reports during auto-negotiation. Possible values are: I<Sym>, I<SymOrRem>, "
8922 "I<LocSend> or I<None> whereas I<SymOrRem> is the default. The different "
8923 "modes have the following meaning:"
8927 #: build/C/man4/sk98lin.4:320 build/C/man4/sk98lin.4:353
8932 " both link partners are allowed to send PAUSE frames\n"
8936 #: build/C/man4/sk98lin.4:324 build/C/man4/sk98lin.4:357
8940 "= SymmetricOrRemote\n"
8941 " both or only remote partner are allowed to send PAUSE frames\n"
8945 #: build/C/man4/sk98lin.4:328 build/C/man4/sk98lin.4:361
8950 " only local link partner is allowed to send PAUSE frames\n"
8954 #: build/C/man4/sk98lin.4:332 build/C/man4/sk98lin.4:365
8959 " no link partner is allowed to send PAUSE frames\n"
8963 #: build/C/man4/sk98lin.4:335
8964 msgid "Note that this parameter is ignored if AutoNeg_A is set to I<Off>."
8968 #: build/C/man4/sk98lin.4:335
8970 msgid "B<FlowCtrl_B=>I<i,j,...>"
8974 #: build/C/man4/sk98lin.4:369
8975 msgid "Note that this parameter is ignored if AutoNeg_B is set to I<Off>."
8979 #: build/C/man4/sk98lin.4:369
8981 msgid "B<Role_A=>I<i,j,...>"
8985 #: build/C/man4/sk98lin.4:386
8987 "This parameter is only valid for 1000Base-T adapter cards. For two "
8988 "1000Base-T ports to communicate, one must take the role of the master "
8989 "(providing timing information), while the other must be the slave. Possible "
8990 "values are: I<Auto>, I<Master> or I<Slave> whereas I<Auto> is the default. "
8991 "Usually, the role of a port is negotiated between two ports during link "
8992 "establishment, but if that fails the port A of an adapter card can be forced "
8993 "to a specific setting with this parameter."
8997 #: build/C/man4/sk98lin.4:386
8999 msgid "B<Role_B=>I<i,j,...>"
9003 #: build/C/man4/sk98lin.4:404
9005 "This parameter is only valid for 1000Base-T adapter cards. For two "
9006 "1000Base-T ports to communicate, one must take the role of the master "
9007 "(providing timing information), while the other must be the slave. Possible "
9008 "values are: I<Auto>, I<Master> or I<Slave> whereas I<Auto> is the default. "
9009 "Usually, the role of a port is negotiated between two ports during link "
9010 "establishment, but if that fails the port B of an adapter card can be forced "
9011 "to a specific setting with this parameter."
9015 #: build/C/man4/sk98lin.4:404
9017 msgid "B<ConType=>I<i,j,...>"
9021 #: build/C/man4/sk98lin.4:412
9023 "This parameter is a combination of all five per-port parameters within one "
9024 "single parameter. This simplifies the configuration of both ports of an "
9025 "adapter card. The different values of this variable reflect the most "
9026 "meaningful combinations of port parameters. Possible values and their "
9027 "corresponding combination of per-port parameters:"
9031 #: build/C/man4/sk98lin.4:417
9034 "ConType | DupCap AutoNeg FlowCtrl Role Speed\n"
9035 "--------+-------------------------------------------\n"
9036 "I<Auto> | Both On SymOrRem Auto Auto\n"
9040 #: build/C/man4/sk98lin.4:419
9042 msgid "I<100FD> | Full Off None Auto 100\n"
9046 #: build/C/man4/sk98lin.4:421
9048 msgid "I<100HD> | Half Off None Auto 100\n"
9052 #: build/C/man4/sk98lin.4:423
9054 msgid "I<10FD> | Full Off None Auto 10\n"
9058 #: build/C/man4/sk98lin.4:425
9060 msgid "I<10HD> | Half Off None Auto 10\n"
9064 #: build/C/man4/sk98lin.4:435
9066 "Stating any other port parameter together with this I<ConType> parameter "
9067 "will result in a merged configuration of those settings. This is due to the "
9068 "fact, that the per-port parameters (e.g., I<Speed_A>) have a higher "
9069 "priority than the combined variable I<ConType>."
9073 #: build/C/man4/sk98lin.4:435
9075 msgid "B<Moderation=>I<i,j,...>"
9079 #: build/C/man4/sk98lin.4:453
9081 "Interrupt moderation is employed to limit the maximum number of interrupts "
9082 "the driver has to serve. That is, one or more interrupts (which indicate "
9083 "any transmit or receive packet to be processed) are queued until the driver "
9084 "processes them. When queued interrupts are to be served, is determined by "
9085 "the I<IntsPerSec> parameter, which is explained later below. Possible "
9086 "moderation modes are: I<None>, I<Static> or I<Dynamic> whereas I<None> is "
9087 "the default. The different modes have the following meaning:"
9091 #: build/C/man4/sk98lin.4:458
9093 "I<None> No interrupt moderation is applied on the adapter card. Therefore, "
9094 "each transmit or receive interrupt is served immediately as soon as it "
9095 "appears on the interrupt line of the adapter card."
9099 #: build/C/man4/sk98lin.4:473
9101 "I<Static> Interrupt moderation is applied on the adapter card. All transmit "
9102 "and receive interrupts are queued until a complete moderation interval "
9103 "ends. If such a moderation interval ends, all queued interrupts are "
9104 "processed in one big bunch without any delay. The term I<Static> reflects "
9105 "the fact, that interrupt moderation is always enabled, regardless how much "
9106 "network load is currently passing via a particular interface. In addition, "
9107 "the duration of the moderation interval has a fixed length that never "
9108 "changes while the driver is operational."
9112 #: build/C/man4/sk98lin.4:484
9114 "I<Dynamic> Interrupt moderation might be applied on the adapter card, "
9115 "depending on the load of the system. If the driver detects that the system "
9116 "load is too high, the driver tries to shield the system against too much "
9117 "network load by enabling interrupt moderation. If\\(emat a later "
9118 "time\\(emthe CPU utilization decreases again (or if the network load is "
9119 "negligible) the interrupt moderation will automatically be disabled."
9123 #: build/C/man4/sk98lin.4:490
9125 "Interrupt moderation should be used when the driver has to handle one or "
9126 "more interfaces with a high network load, which\\(emas a "
9127 "consequence\\(emleads also to a high CPU utilization. When moderation is "
9128 "applied in such high network load situations, CPU load might be reduced by "
9129 "20-30% on slow computers."
9133 #: build/C/man4/sk98lin.4:494
9135 "Note that the drawback of using interrupt moderation is an increase of the "
9136 "round-trip-time (RTT), due to the queuing and serving of interrupts at "
9137 "dedicated moderation times."
9141 #: build/C/man4/sk98lin.4:494
9143 msgid "B<IntsPerSec=>I<i,j,...>"
9147 #: build/C/man4/sk98lin.4:504
9149 "This parameter determines the length of any interrupt moderation interval. "
9150 "Assuming that static interrupt moderation is to be used, an I<IntsPerSec> "
9151 "parameter value of 2000 will lead to an interrupt moderation interval of 500 "
9152 "microseconds. Possible values for this parameter are in the range of "
9153 "30...40000 (interrupts per second). The default value is 2000."
9157 #: build/C/man4/sk98lin.4:508
9159 "This parameter is only used, if either static or dynamic interrupt "
9160 "moderation is enabled on a network adapter card. This parameter is ignored "
9161 "if no moderation is applied."
9165 #: build/C/man4/sk98lin.4:515
9167 "Note that the duration of the moderation interval is to be chosen with "
9168 "care. At first glance, selecting a very long duration (e.g., only 100 "
9169 "interrupts per second) seems to be meaningful, but the increase of "
9170 "packet-processing delay is tremendous. On the other hand, selecting a very "
9171 "short moderation time might compensate the use of any moderation being "
9176 #: build/C/man4/sk98lin.4:515
9178 msgid "B<PrefPort=>I<i,j,...>"
9182 #: build/C/man4/sk98lin.4:528
9184 "This parameter is used to force the preferred port to A or B (on dual-port "
9185 "network adapters). The preferred port is the one that is used if both ports "
9186 "A and B are detected as fully functional. Possible values are: I<A> or I<B> "
9187 "whereas I<A> is the default."
9191 #: build/C/man4/sk98lin.4:528
9193 msgid "B<RlmtMode=>I<i,j,...>"
9197 #: build/C/man4/sk98lin.4:545
9199 "RLMT monitors the status of the port. If the link of the active port fails, "
9200 "RLMT switches immediately to the standby link. The virtual link is "
9201 "maintained as long as at least one \"physical\" link is up. This parameters "
9202 "states how RLMT should monitor both ports. Possible values are: "
9203 "I<CheckLinkState>, I<CheckLocalPort>, I<CheckSeg> or I<DualNet> whereas "
9204 "I<CheckLinkState> is the default. The different modes have the following "
9209 #: build/C/man4/sk98lin.4:550
9211 "I<CheckLinkState> Check link state only: RLMT uses the link state reported "
9212 "by the adapter hardware for each individual port to determine whether a port "
9213 "can be used for all network traffic or not."
9217 #: build/C/man4/sk98lin.4:558
9219 "I<CheckLocalPort> In this mode, RLMT monitors the network path between the "
9220 "two ports of an adapter by regularly exchanging packets between them. This "
9221 "mode requires a network configuration in which the two ports are able to "
9222 "\"see\" each other (i.e., there must not be any router between the ports)."
9226 #: build/C/man4/sk98lin.4:567
9228 "I<CheckSeg> Check local port and segmentation: This mode supports the same "
9229 "functions as the CheckLocalPort mode and additionally checks network "
9230 "segmentation between the ports. Therefore, this mode is only to be used if "
9231 "Gigabit Ethernet switches are installed on the network that have been "
9232 "configured to use the Spanning Tree protocol."
9236 #: build/C/man4/sk98lin.4:578
9238 "I<DualNet> In this mode, ports A and B are used as separate devices. If you "
9239 "have a dual port adapter, port A will be configured as I<eth[x]> and port B "
9240 "as I<eth[x+1]>. Both ports can be used independently with distinct IP "
9241 "addresses. The preferred port setting is not used. RLMT is turned off."
9245 #: build/C/man4/sk98lin.4:587
9247 "Note that RLMT modes I<CheckLocalPort> and I<CheckLinkState> are designed to "
9248 "operate in configurations where a network path between the ports on one "
9249 "adapter exists. Moreover, they are not designed to work where adapters are "
9250 "connected back-to-back."
9254 #: build/C/man4/sk98lin.4:588
9256 msgid "I</proc/net/sk98lin/eth[x]>"
9260 #: build/C/man4/sk98lin.4:594
9262 "The statistics file of a particular interface of an adapter card. It "
9263 "contains generic information about the adapter card plus a detailed summary "
9264 "of all transmit and receive counters."
9268 #: build/C/man4/sk98lin.4:594
9270 msgid "I</usr/src/linux/Documentation/networking/sk98lin.txt>"
9274 #: build/C/man4/sk98lin.4:605
9276 "This is the I<README> file of the I<sk98lin> driver. It contains a detailed "
9277 "installation HOWTO and describes all parameters of the driver. It denotes "
9278 "also common problems and provides the solution to them."
9282 #. Ralph Roesler \(em rroesler@syskonnect.de
9284 #. Mirko Lindner \(em mlindner@syskonnect.de
9286 #: build/C/man4/sk98lin.4:611
9287 msgid "Report any bugs to linux@syskonnect.de"
9291 #: build/C/man4/sk98lin.4:615
9292 msgid "B<ifconfig>(8), B<insmod>(8), B<modprobe>(8)"
9296 #: build/C/man4/st.4:25
9302 #: build/C/man4/st.4:28
9303 msgid "st - SCSI tape device"
9307 #: build/C/man4/st.4:31
9309 msgid "B<#include E<lt>sys/mtio.hE<gt>>\n"
9313 #: build/C/man4/st.4:36
9316 "B<int ioctl(int >I<fd>B<, int >I<request>B< [, (void *)>I<arg3>B<]);>\n"
9317 "B<int ioctl(int >I<fd>B<, MTIOCTOP, (struct mtop *)>I<mt_cmd>B<);>\n"
9318 "B<int ioctl(int >I<fd>B<, MTIOCGET, (struct mtget *)>I<mt_status>B<);>\n"
9319 "B<int ioctl(int >I<fd>B<, MTIOCPOS, (struct mtpos *)>I<mt_pos>B<);>\n"
9323 #: build/C/man4/st.4:46
9325 "The B<st> driver provides the interface to a variety of SCSI tape devices. "
9326 "Currently, the driver takes control of all detected devices of type "
9327 "\\(lqsequential-access\\(rq. The B<st> driver uses major device number 9."
9331 #: build/C/man4/st.4:66
9333 "Each device uses eight minor device numbers. The lowermost five bits in the "
9334 "minor numbers are assigned sequentially in the order of detection. In the "
9335 "2.6 kernel, the bits above the eight lowermost bits are concatenated to the "
9336 "five lowermost bits to form the tape number. The minor numbers can be "
9337 "grouped into two sets of four numbers: the principal (auto-rewind) minor "
9338 "device numbers, I<n>, and the \\(lqno-rewind\\(rq device numbers, (I<n> + "
9339 "128). Devices opened using the principal device number will be sent a "
9340 "B<REWIND> command when they are closed. Devices opened using the "
9341 "\\(lqno-rewind\\(rq device number will not. (Note that using an auto-rewind "
9342 "device for positioning the tape with, for instance, mt does not lead to the "
9343 "desired result: the tape is rewound after the mt command and the next "
9344 "command starts from the beginning of the tape)."
9348 #: build/C/man4/st.4:80
9350 "Within each group, four minor numbers are available to define devices with "
9351 "different characteristics (block size, compression, density, etc.) When the "
9352 "system starts up, only the first device is available. The other three are "
9353 "activated when the default characteristics are defined (see below). (By "
9354 "changing compile-time constants, it is possible to change the balance "
9355 "between the maximum number of tape drives and the number of minor numbers "
9356 "for each drive. The default allocation allows control of 32 tape drives. "
9357 "For instance, it is possible to control up to 64 tape drives with two minor "
9358 "numbers for different options.)"
9362 #: build/C/man4/st.4:82
9363 msgid "Devices are typically created by:"
9367 #: build/C/man4/st.4:93
9370 "mknod -m 666 /dev/st0 c 9 0\n"
9371 "mknod -m 666 /dev/st0l c 9 32\n"
9372 "mknod -m 666 /dev/st0m c 9 64\n"
9373 "mknod -m 666 /dev/st0a c 9 96\n"
9374 "mknod -m 666 /dev/nst0 c 9 128\n"
9375 "mknod -m 666 /dev/nst0l c 9 160\n"
9376 "mknod -m 666 /dev/nst0m c 9 192\n"
9377 "mknod -m 666 /dev/nst0a c 9 224\n"
9381 #: build/C/man4/st.4:97
9382 msgid "There is no corresponding block device."
9386 #: build/C/man4/st.4:112
9388 "The driver uses an internal buffer that has to be large enough to hold at "
9389 "least one tape block. In kernels before 2.1.121, the buffer is allocated as "
9390 "one contiguous block. This limits the block size to the largest contiguous "
9391 "block of memory the kernel allocator can provide. The limit is currently "
9392 "128 kB for 32-bit architectures and 256 kB for 64-bit architectures. In "
9393 "newer kernels the driver allocates the buffer in several parts if "
9394 "necessary. By default, the maximum number of parts is 16. This means that "
9395 "the maximum block size is very large (2 MB if allocation of 16 blocks of 128 "
9400 #: build/C/man4/st.4:121
9402 "The driver's internal buffer size is determined by a compile-time constant "
9403 "which can be overridden with a kernel startup option. In addition to this, "
9404 "the driver tries to allocate a larger temporary buffer at run time if "
9405 "necessary. However, run-time allocation of large contiguous blocks of "
9406 "memory may fail and it is advisable not to rely too much on dynamic buffer "
9407 "allocation with kernels older than 2.1.121 (this applies also to "
9408 "demand-loading the driver with kerneld or kmod)."
9412 #: build/C/man4/st.4:134
9414 "The driver does not specifically support any tape drive brand or model. "
9415 "After system start-up the tape device options are defined by the drive "
9416 "firmware. For example, if the drive firmware selects fixed-block mode, the "
9417 "tape device uses fixed-block mode. The options can be changed with explicit "
9418 "B<ioctl>(2) calls and remain in effect when the device is closed and "
9419 "reopened. Setting the options affects both the auto-rewind and the "
9424 #: build/C/man4/st.4:143
9426 "Different options can be specified for the different devices within the "
9427 "subgroup of four. The options take effect when the device is opened. For "
9428 "example, the system administrator can define one device that writes in "
9429 "fixed-block mode with a certain block size, and one which writes in "
9430 "variable-block mode (if the drive supports both modes)."
9434 #: build/C/man4/st.4:166
9436 "The driver supports B<tape partitions> if they are supported by the drive. "
9437 "(Note that the tape partitions have nothing to do with disk partitions. A "
9438 "partitioned tape can be seen as several logical tapes within one medium.) "
9439 "Partition support has to be enabled with an B<ioctl>(2). The tape location "
9440 "is preserved within each partition across partition changes. The partition "
9441 "used for subsequent tape operations is selected with an B<ioctl>(2). The "
9442 "partition switch is executed together with the next tape operation in order "
9443 "to avoid unnecessary tape movement. The maximum number of partitions on a "
9444 "tape is defined by a compile-time constant (originally four). The driver "
9445 "contains an B<ioctl>(2) that can format a tape with either one or two "
9450 #: build/C/man4/st.4:171
9452 "Device I</dev/tape> is usually created as a hard or soft link to the default "
9453 "tape device on the system."
9457 #: build/C/man4/st.4:175
9459 "Starting from kernel 2.6.2, the driver exports in the sysfs directory "
9460 "I</sys/class/scsi_tape> the attached devices and some parameters assigned to "
9465 #: build/C/man4/st.4:175
9467 msgid "Data transfer"
9471 #: build/C/man4/st.4:188
9473 "The driver supports operation in both fixed-block mode and variable-block "
9474 "mode (if supported by the drive). In fixed-block mode the drive writes "
9475 "blocks of the specified size and the block size is not dependent on the byte "
9476 "counts of the write system calls. In variable-block mode one tape block is "
9477 "written for each write call and the byte count determines the size of the "
9478 "corresponding tape block. Note that the blocks on the tape don't contain "
9479 "any information about the writing mode: when reading, the only important "
9480 "thing is to use commands that accept the block sizes on the tape."
9484 #: build/C/man4/st.4:197
9486 "In variable-block mode the read byte count does not have to match the tape "
9487 "block size exactly. If the byte count is larger than the next block on "
9488 "tape, the driver returns the data and the function returns the actual block "
9489 "size. If the block size is larger than the byte count, the requested amount "
9490 "of data from the start of the block is returned and the rest of the block is "
9495 #: build/C/man4/st.4:206
9497 "In fixed-block mode the read byte counts can be arbitrary if buffering is "
9498 "enabled, or a multiple of the tape block size if buffering is disabled. "
9499 "Kernels before 2.1.121 allow writes with arbitrary byte count if buffering "
9500 "is enabled. In all other cases (kernel before 2.1.121 with buffering "
9501 "disabled or newer kernel) the write byte count must be a multiple of the "
9506 #: build/C/man4/st.4:215
9508 "In the 2.6 kernel, the driver tries to use direct transfers between the user "
9509 "buffer and the device. If this is not possible, the driver's internal "
9510 "buffer is used. The reasons for not using direct transfers include improper "
9511 "alignment of the user buffer (default is 512 bytes but this can be changed "
9512 "by the HBA driver), one of more pages of the user buffer not reachable by "
9513 "the SCSI adapter, etc."
9517 #: build/C/man4/st.4:218
9519 "A filemark is automatically written to tape if the last tape operation "
9520 "before close was a write."
9524 #: build/C/man4/st.4:230
9526 "When a filemark is encountered while reading, the following happens. If "
9527 "there are data remaining in the buffer when the filemark is found, the "
9528 "buffered data is returned. The next read returns zero bytes. The following "
9529 "read returns data from the next file. The end of recorded data is signaled "
9530 "by returning zero bytes for two consecutive read calls. The third read "
9535 #: build/C/man4/st.4:230
9541 #: build/C/man4/st.4:241
9543 "The driver supports three B<ioctl>(2) requests. Requests not recognized by "
9544 "the B<st> driver are passed to the B<SCSI> driver. The definitions below "
9545 "are from I</usr/include/linux/mtio.h>:"
9549 #: build/C/man4/st.4:241
9551 msgid "MTIOCTOP \\(em perform a tape operation"
9555 #: build/C/man4/st.4:249
9557 "This request takes an argument of type I<(struct mtop *)>. Not all drives "
9558 "support all operations. The driver returns an B<EIO> error if the drive "
9559 "rejects an operation."
9563 #: build/C/man4/st.4:257
9566 "/* Structure for MTIOCTOP - mag tape op command: */\n"
9568 " short mt_op; /* operations defined below */\n"
9569 " int mt_count; /* how many of them */\n"
9574 #: build/C/man4/st.4:261
9575 msgid "Magnetic Tape operations for normal tape use:"
9579 #: build/C/man4/st.4:261
9585 #: build/C/man4/st.4:266
9586 msgid "Backward space over I<mt_count> filemarks."
9590 #: build/C/man4/st.4:266
9596 #: build/C/man4/st.4:272
9598 "Backward space over I<mt_count> filemarks. Reposition the tape to the EOT "
9599 "side of the last filemark."
9603 #: build/C/man4/st.4:272
9609 #: build/C/man4/st.4:277
9610 msgid "Backward space over I<mt_count> records (tape blocks)."
9614 #: build/C/man4/st.4:277
9620 #: build/C/man4/st.4:282
9621 msgid "Backward space over I<mt_count> setmarks."
9625 #: build/C/man4/st.4:282
9627 msgid "B<MTCOMPRESSION>"
9631 #: build/C/man4/st.4:290
9633 "Enable compression of tape data within the drive if I<mt_count> is nonzero "
9634 "and disable compression if I<mt_count> is zero. This command uses the MODE "
9635 "page 15 supported by most DATs."
9639 #: build/C/man4/st.4:290
9645 #: build/C/man4/st.4:293
9646 msgid "Go to the end of the recorded media (for appending files)."
9650 #: build/C/man4/st.4:293
9656 #: build/C/man4/st.4:299
9658 "Erase tape. With 2.6 kernel, short erase (mark tape empty) is performed if "
9659 "the argument is zero. Otherwise long erase (erase all) is done."
9663 #: build/C/man4/st.4:299
9669 #: build/C/man4/st.4:304
9670 msgid "Forward space over I<mt_count> filemarks."
9674 #: build/C/man4/st.4:304
9680 #: build/C/man4/st.4:310
9682 "Forward space over I<mt_count> filemarks. Reposition the tape to the BOT "
9683 "side of the last filemark."
9687 #: build/C/man4/st.4:310
9693 #: build/C/man4/st.4:315
9694 msgid "Forward space over I<mt_count> records (tape blocks)."
9698 #: build/C/man4/st.4:315
9704 #: build/C/man4/st.4:320
9705 msgid "Forward space over I<mt_count> setmarks."
9709 #: build/C/man4/st.4:320
9715 #: build/C/man4/st.4:331
9717 "Execute the SCSI load command. A special case is available for some HP "
9718 "autoloaders. If I<mt_count> is the constant B<MT_ST_HPLOADER_OFFSET> plus a "
9719 "number, the number is sent to the drive to control the autoloader."
9723 #: build/C/man4/st.4:331
9729 #: build/C/man4/st.4:334
9730 msgid "Lock the tape drive door."
9734 #: build/C/man4/st.4:334
9740 #: build/C/man4/st.4:348
9742 "Format the tape into one or two partitions. If I<mt_count> is nonzero, it "
9743 "gives the size of the first partition and the second partition contains the "
9744 "rest of the tape. If I<mt_count> is zero, the tape is formatted into one "
9745 "partition. This command is not allowed for a drive unless the partition "
9746 "support is enabled for the drive (see B<MT_ST_CAN_PARTITIONS> below)."
9750 #: build/C/man4/st.4:348
9756 #: build/C/man4/st.4:353
9758 "No op\\(emflushes the driver's buffer as a side effect. Should be used "
9759 "before reading status with B<MTIOCGET>."
9763 #: build/C/man4/st.4:353
9769 #: build/C/man4/st.4:356
9770 msgid "Rewind and put the drive off line."
9774 #: build/C/man4/st.4:356
9780 #: build/C/man4/st.4:359
9781 msgid "Reset drive."
9785 #: build/C/man4/st.4:359
9791 #: build/C/man4/st.4:362
9792 msgid "Re-tension tape."
9796 #: build/C/man4/st.4:362
9802 #: build/C/man4/st.4:365
9807 #: build/C/man4/st.4:365
9813 #: build/C/man4/st.4:377
9815 "Seek to the tape block number specified in I<mt_count>. This operation "
9816 "requires either a SCSI-2 drive that supports the B<LOCATE> command "
9817 "(device-specific address) or a Tandberg-compatible SCSI-1 drive (Tandberg, "
9818 "Archive Viper, Wangtek, ...). The block number should be one that was "
9819 "previously returned by B<MTIOCPOS> if device-specific addresses are used."
9823 #: build/C/man4/st.4:377
9829 #: build/C/man4/st.4:382
9831 "Set the drive's block length to the value specified in I<mt_count>. A block "
9832 "length of zero sets the drive to variable block size mode."
9836 #: build/C/man4/st.4:382
9838 msgid "B<MTSETDENSITY>"
9842 #: build/C/man4/st.4:388
9844 "Set the tape density to the code in I<mt_count>. The density codes "
9845 "supported by a drive can be found from the drive documentation."
9849 #: build/C/man4/st.4:388
9851 msgid "B<MTSETPART>"
9855 #: build/C/man4/st.4:397
9857 "The active partition is switched to I<mt_count>. The partitions are "
9858 "numbered from zero. This command is not allowed for a drive unless the "
9859 "partition support is enabled for the drive (see B<MT_ST_CAN_PARTITIONS> "
9864 #: build/C/man4/st.4:397
9870 #: build/C/man4/st.4:400
9871 msgid "Execute the SCSI unload command (does not eject the tape)."
9875 #: build/C/man4/st.4:400
9881 #: build/C/man4/st.4:403
9882 msgid "Unlock the tape drive door."
9886 #: build/C/man4/st.4:403
9892 #: build/C/man4/st.4:408
9893 msgid "Write I<mt_count> filemarks."
9897 #: build/C/man4/st.4:408
9903 #: build/C/man4/st.4:413
9904 msgid "Write I<mt_count> setmarks."
9908 #: build/C/man4/st.4:415
9909 msgid "Magnetic Tape operations for setting of device options (by the superuser):"
9913 #: build/C/man4/st.4:415
9915 msgid "B<MTSETDRVBUFFER>"
9919 #: build/C/man4/st.4:424
9921 "Set various drive and driver options according to bits encoded in "
9922 "I<mt_count>. These consist of the drive's buffering mode, a set of Boolean "
9923 "driver options, the buffer write threshold, defaults for the block size and "
9924 "density, and timeouts (only in kernels 2.1 and later). A single operation "
9925 "can affect only one item in the list above (the Booleans counted as one "
9930 #: build/C/man4/st.4:428
9932 "A value having zeros in the high-order 4 bits will be used to set the "
9933 "drive's buffering mode. The buffering modes are:"
9937 #: build/C/man4/st.4:429
9943 #: build/C/man4/st.4:434
9945 "The drive will not report B<GOOD> status on write commands until the data "
9946 "blocks are actually written to the medium."
9950 #: build/C/man4/st.4:434
9956 #: build/C/man4/st.4:439
9958 "The drive may report B<GOOD> status on write commands as soon as all the "
9959 "data has been transferred to the drive's internal buffer."
9963 #: build/C/man4/st.4:439
9969 #: build/C/man4/st.4:446
9971 "The drive may report B<GOOD> status on write commands as soon as (a) all the "
9972 "data has been transferred to the drive's internal buffer, and (b) all "
9973 "buffered data from different initiators has been successfully written to the "
9978 #: build/C/man4/st.4:457
9980 "To control the write threshold the value in I<mt_count> must include the "
9981 "constant B<MT_ST_WRITE_THRESHOLD> bitwise ORed with a block count in the low "
9982 "28 bits. The block count refers to 1024-byte blocks, not the physical block "
9983 "size on the tape. The threshold cannot exceed the driver's internal buffer "
9984 "size (see DESCRIPTION, above)."
9988 #: build/C/man4/st.4:478
9990 "To set and clear the Boolean options the value in I<mt_count> must include "
9991 "one of the constants B<MT_ST_BOOLEANS>, B<MT_ST_SETBOOLEANS>, "
9992 "B<MT_ST_CLEARBOOLEANS>, or B<MT_ST_DEFBOOLEANS> bitwise ORed with whatever "
9993 "combination of the following options is desired. Using B<MT_ST_BOOLEANS> "
9994 "the options can be set to the values defined in the corresponding bits. "
9995 "With B<MT_ST_SETBOOLEANS> the options can be selectively set and with "
9996 "B<MT_ST_DEFBOOLEANS> selectively cleared."
10000 #: build/C/man4/st.4:486
10002 "The default options for a tape device are set with B<MT_ST_DEFBOOLEANS>. A "
10003 "nonactive tape device (e.g., device with minor 32 or 160) is activated when "
10004 "the default options for it are defined the first time. An activated device "
10005 "inherits from the device activated at start-up the options not set "
10009 #. type: Plain text
10010 #: build/C/man4/st.4:488
10011 msgid "The Boolean options are:"
10015 #: build/C/man4/st.4:489
10017 msgid "B<MT_ST_BUFFER_WRITES> (Default: true)"
10020 #. type: Plain text
10021 #: build/C/man4/st.4:495
10023 "Buffer all write operations in fixed-block mode. If this option is false "
10024 "and the drive uses a fixed block size, then all write operations must be for "
10025 "a multiple of the block size. This option must be set false to write "
10026 "reliable multivolume archives."
10030 #: build/C/man4/st.4:495
10032 msgid "B<MT_ST_ASYNC_WRITES> (Default: true)"
10035 #. type: Plain text
10036 #: build/C/man4/st.4:505
10038 "When this option is true, write operations return immediately without "
10039 "waiting for the data to be transferred to the drive if the data fits into "
10040 "the driver's buffer. The write threshold determines how full the buffer "
10041 "must be before a new SCSI write command is issued. Any errors reported by "
10042 "the drive will be held until the next operation. This option must be set "
10043 "false to write reliable multivolume archives."
10047 #: build/C/man4/st.4:505
10049 msgid "B<MT_ST_READ_AHEAD> (Default: true)"
10052 #. type: Plain text
10053 #: build/C/man4/st.4:511
10055 "This option causes the driver to provide read buffering and read-ahead in "
10056 "fixed-block mode. If this option is false and the drive uses a fixed block "
10057 "size, then all read operations must be for a multiple of the block size."
10061 #: build/C/man4/st.4:511
10063 msgid "B<MT_ST_TWO_FM> (Default: false)"
10066 #. type: Plain text
10067 #: build/C/man4/st.4:517
10069 "This option modifies the driver behavior when a file is closed. The normal "
10070 "action is to write a single filemark. If the option is true the driver will "
10071 "write two filemarks and backspace over the second one."
10074 #. type: Plain text
10075 #: build/C/man4/st.4:526
10077 "Note: This option should not be set true for QIC tape drives since they are "
10078 "unable to overwrite a filemark. These drives detect the end of recorded "
10079 "data by testing for blank tape rather than two consecutive filemarks. Most "
10080 "other current drives also detect the end of recorded data and using two "
10081 "filemarks is usually necessary only when interchanging tapes with some other "
10086 #: build/C/man4/st.4:526
10088 msgid "B<MT_ST_DEBUGGING> (Default: false)"
10091 #. type: Plain text
10092 #: build/C/man4/st.4:532
10094 "This option turns on various debugging messages from the driver (effective "
10095 "only if the driver was compiled with B<DEBUG> defined nonzero)."
10099 #: build/C/man4/st.4:532
10101 msgid "B<MT_ST_FAST_EOM> (Default: false)"
10104 #. type: Plain text
10105 #: build/C/man4/st.4:546
10107 "This option causes the B<MTEOM> operation to be sent directly to the drive, "
10108 "potentially speeding up the operation but causing the driver to lose track "
10109 "of the current file number normally returned by the B<MTIOCGET> request. If "
10110 "B<MT_ST_FAST_EOM> is false the driver will respond to an B<MTEOM> request by "
10111 "forward spacing over files."
10115 #: build/C/man4/st.4:546
10117 msgid "B<MT_ST_AUTO_LOCK> (Default: false)"
10120 #. type: Plain text
10121 #: build/C/man4/st.4:550
10123 "When this option is true, the drive door is locked when the device is opened "
10124 "and unlocked when it is closed."
10128 #: build/C/man4/st.4:550
10130 msgid "B<MT_ST_DEF_WRITES> (Default: false)"
10133 #. type: Plain text
10134 #: build/C/man4/st.4:567
10136 "The tape options (block size, mode, compression, etc.) may change when "
10137 "changing from one device linked to a drive to another device linked to the "
10138 "same drive depending on how the devices are defined. This option defines "
10139 "when the changes are enforced by the driver using SCSI-commands and when the "
10140 "drives auto-detection capabilities are relied upon. If this option is "
10141 "false, the driver sends the SCSI-commands immediately when the device is "
10142 "changed. If the option is true, the SCSI-commands are not sent until a "
10143 "write is requested. In this case the drive firmware is allowed to detect "
10144 "the tape structure when reading and the SCSI-commands are used only to make "
10145 "sure that a tape is written according to the correct specification."
10149 #: build/C/man4/st.4:567
10151 msgid "B<MT_ST_CAN_BSR> (Default: false)"
10154 #. type: Plain text
10155 #: build/C/man4/st.4:580
10157 "When read-ahead is used, the tape must sometimes be spaced backward to the "
10158 "correct position when the device is closed and the SCSI command to space "
10159 "backward over records is used for this purpose. Some older drives can't "
10160 "process this command reliably and this option can be used to instruct the "
10161 "driver not to use the command. The end result is that, with read-ahead and "
10162 "fixed-block mode, the tape may not be correctly positioned within a file "
10163 "when the device is closed. With 2.6 kernel, the default is true for drives "
10164 "supporting SCSI-3."
10168 #: build/C/man4/st.4:580
10170 msgid "B<MT_ST_NO_BLKLIMS> (Default: false)"
10173 #. type: Plain text
10174 #: build/C/man4/st.4:589
10176 "Some drives don't accept the B<READ BLOCK LIMITS> SCSI command. If this is "
10177 "used, the driver does not use the command. The drawback is that the driver "
10178 "can't check before sending commands if the selected block size is acceptable "
10183 #: build/C/man4/st.4:589
10185 msgid "B<MT_ST_CAN_PARTITIONS> (Default: false)"
10188 #. type: Plain text
10189 #: build/C/man4/st.4:594
10191 "This option enables support for several partitions within a tape. The "
10192 "option applies to all devices linked to a drive."
10196 #: build/C/man4/st.4:594
10198 msgid "B<MT_ST_SCSI2LOGICAL> (Default: false)"
10201 #. type: Plain text
10202 #: build/C/man4/st.4:609
10204 "This option instructs the driver to use the logical block addresses defined "
10205 "in the SCSI-2 standard when performing the seek and tell operations (both "
10206 "with B<MTSEEK> and B<MTIOCPOS> commands and when changing tape partition). "
10207 "Otherwise the device-specific addresses are used. It is highly advisable to "
10208 "set this option if the drive supports the logical addresses because they "
10209 "count also filemarks. There are some drives that only support the logical "
10214 #: build/C/man4/st.4:609
10216 msgid "B<MT_ST_SYSV> (Default: false)"
10219 #. type: Plain text
10220 #: build/C/man4/st.4:620
10222 "When this option is enabled, the tape devices use the SystemV semantics. "
10223 "Otherwise the BSD semantics are used. The most important difference between "
10224 "the semantics is what happens when a device used for reading is closed: in "
10225 "System V semantics the tape is spaced forward past the next filemark if this "
10226 "has not happened while using the device. In BSD semantics the tape position "
10231 #: build/C/man4/st.4:620
10233 msgid "B<MT_NO_WAIT> (Default: false)"
10236 #. type: Plain text
10237 #: build/C/man4/st.4:624
10239 "Enables immediate mode (i.e., don't wait for the command to finish) for some "
10240 "commands (e.g., rewind)."
10243 #. type: Plain text
10244 #: build/C/man4/st.4:626
10245 msgid "An example:"
10248 #. type: Plain text
10249 #: build/C/man4/st.4:634
10252 "struct mtop mt_cmd;\n"
10253 "mt_cmd.mt_op = MTSETDRVBUFFER;\n"
10254 "mt_cmd.mt_count = MT_ST_BOOLEANS |\n"
10255 " MT_ST_BUFFER_WRITES | MT_ST_ASYNC_WRITES;\n"
10256 "ioctl(fd, MTIOCTOP, mt_cmd);\n"
10259 #. type: Plain text
10260 #: build/C/man4/st.4:644
10262 "The default block size for a device can be set with B<MT_ST_DEF_BLKSIZE> and "
10263 "the default density code can be set with B<MT_ST_DEFDENSITY>. The values "
10264 "for the parameters are or'ed with the operation code."
10267 #. type: Plain text
10268 #: build/C/man4/st.4:661
10270 "With kernels 2.1.x and later, the timeout values can be set with the "
10271 "subcommand B<MT_ST_SET_TIMEOUT> ORed with the timeout in seconds. The long "
10272 "timeout (used for rewinds and other commands that may take a long time) can "
10273 "be set with B<MT_ST_SET_LONG_TIMEOUT>. The kernel defaults are very long to "
10274 "make sure that a successful command is not timed out with any drive. "
10275 "Because of this the driver may seem stuck even if it is only waiting for the "
10276 "timeout. These commands can be used to set more practical values for a "
10277 "specific drive. The timeouts set for one device apply for all devices "
10278 "linked to the same drive."
10281 #. type: Plain text
10282 #: build/C/man4/st.4:682
10284 "Starting from kernels 2.4.19 and 2.5.43, the driver supports a status bit "
10285 "which indicates whether the drive requests cleaning. The method used by the "
10286 "drive to return cleaning information is set using the B<MT_ST_SEL_CLN> "
10287 "subcommand. If the value is zero, the cleaning bit is always zero. If the "
10288 "value is one, the TapeAlert data defined in the SCSI-3 standard is used (not "
10289 "yet implemented). Values 2-17 are reserved. If the lowest eight bits are "
10290 "E<gt>= 18, bits from the extended sense data are used. The bits 9-16 "
10291 "specify a mask to select the bits to look at and the bits 17-23 specify the "
10292 "bit pattern to look for. If the bit pattern is zero, one or more bits under "
10293 "the mask indicate the cleaning request. If the pattern is nonzero, the "
10294 "pattern must match the masked sense data byte."
10298 #: build/C/man4/st.4:682
10300 msgid "MTIOCGET \\(em get status"
10303 #. type: Plain text
10304 #: build/C/man4/st.4:686
10305 msgid "This request takes an argument of type I<(struct mtget *)>."
10308 #. type: Plain text
10309 #: build/C/man4/st.4:701
10312 "/* structure for MTIOCGET - mag tape get status command */\n"
10315 " long mt_resid;\n"
10316 " /* the following registers are device dependent */\n"
10317 " long mt_dsreg;\n"
10318 " long mt_gstat;\n"
10319 " long mt_erreg;\n"
10320 " /* The next two fields are not always used */\n"
10321 " daddr_t mt_fileno;\n"
10322 " daddr_t mt_blkno;\n"
10327 #: build/C/man4/st.4:703
10332 #. type: Plain text
10333 #: build/C/man4/st.4:712
10335 "The header file defines many values for I<mt_type>, but the current driver "
10336 "reports only the generic types B<MT_ISSCSI1> (Generic SCSI-1 tape) and "
10337 "B<MT_ISSCSI2> (Generic SCSI-2 tape)."
10341 #: build/C/man4/st.4:712
10343 msgid "I<mt_resid>"
10346 #. type: Plain text
10347 #: build/C/man4/st.4:714
10348 msgid "contains the current tape partition number."
10352 #: build/C/man4/st.4:714
10354 msgid "I<mt_dsreg>"
10357 #. type: Plain text
10358 #: build/C/man4/st.4:723
10360 "reports the drive's current settings for block size (in the low 24 bits) and "
10361 "density (in the high 8 bits). These fields are defined by "
10362 "B<MT_ST_BLKSIZE_SHIFT>, B<MT_ST_BLKSIZE_MASK>, B<MT_ST_DENSITY_SHIFT>, and "
10363 "B<MT_ST_DENSITY_MASK>."
10367 #: build/C/man4/st.4:723
10369 msgid "I<mt_gstat>"
10372 #. type: Plain text
10373 #: build/C/man4/st.4:726
10375 "reports generic (device independent) status information. The header file "
10376 "defines macros for testing these status bits:"
10379 #. type: Plain text
10380 #: build/C/man4/st.4:733
10382 "B<GMT_EOF>(I<x>): The tape is positioned just after a filemark (always false "
10383 "after an B<MTSEEK> operation)."
10386 #. type: Plain text
10387 #: build/C/man4/st.4:739
10389 "B<GMT_BOT>(I<x>): The tape is positioned at the beginning of the first file "
10390 "(always false after an B<MTSEEK> operation)."
10393 #. type: Plain text
10394 #: build/C/man4/st.4:742
10395 msgid "B<GMT_EOT>(I<x>): A tape operation has reached the physical End Of Tape."
10398 #. type: Plain text
10399 #: build/C/man4/st.4:748
10401 "B<GMT_SM>(I<x>): The tape is currently positioned at a setmark (always false "
10402 "after an B<MTSEEK> operation)."
10405 #. type: Plain text
10406 #: build/C/man4/st.4:751
10407 msgid "B<GMT_EOD>(I<x>): The tape is positioned at the end of recorded data."
10410 #. type: Plain text
10411 #: build/C/man4/st.4:756
10413 "B<GMT_WR_PROT>(I<x>): The drive is write-protected. For some drives this "
10414 "can also mean that the drive does not support writing on the current medium "
10418 #. type: Plain text
10419 #: build/C/man4/st.4:761
10421 "B<GMT_ONLINE>(I<x>): The last B<open>(2) found the drive with a tape in "
10422 "place and ready for operation."
10425 #. type: Plain text
10426 #: build/C/man4/st.4:765
10428 "B<GMT_D_6250>(I<x>), B<GMT_D_1600>(I<x>), B<GMT_D_800>(I<x>): This "
10429 "\\(lqgeneric\\(rq status information reports the current density setting for "
10430 "9-track \\(12\" tape drives only."
10433 #. type: Plain text
10434 #: build/C/man4/st.4:768
10435 msgid "B<GMT_DR_OPEN>(I<x>): The drive does not have a tape in place."
10438 #. type: Plain text
10439 #: build/C/man4/st.4:776
10441 "B<GMT_IM_REP_EN>(I<x>): Immediate report mode. This bit is set if there are "
10442 "no guarantees that the data has been physically written to the tape when the "
10443 "write call returns. It is set zero only when the driver does not buffer "
10444 "data and the drive is set not to buffer data."
10447 #. type: Plain text
10448 #: build/C/man4/st.4:780
10450 "B<GMT_CLN>(I<x>): The drive has requested cleaning. Implemented in kernels "
10451 "since 2.4.19 and 2.5.43."
10455 #: build/C/man4/st.4:781
10457 msgid "I<mt_erreg>"
10460 #. type: Plain text
10461 #: build/C/man4/st.4:791
10463 "The only field defined in I<mt_erreg> is the recovered error count in the "
10464 "low 16 bits (as defined by B<MT_ST_SOFTERR_SHIFT> and "
10465 "B<MT_ST_SOFTERR_MASK>. Due to inconsistencies in the way drives report "
10466 "recovered errors, this count is often not maintained (most drives do not by "
10467 "default report soft errors but this can be changed with a SCSI MODE SELECT "
10472 #: build/C/man4/st.4:791
10474 msgid "I<mt_fileno>"
10477 #. type: Plain text
10478 #: build/C/man4/st.4:797
10480 "reports the current file number (zero-based). This value is set to -1 when "
10481 "the file number is unknown (e.g., after B<MTBSS> or B<MTSEEK>)."
10485 #: build/C/man4/st.4:797
10487 msgid "I<mt_blkno>"
10490 #. type: Plain text
10491 #: build/C/man4/st.4:804
10493 "reports the block number (zero-based) within the current file. This value "
10494 "is set to -1 when the block number is unknown (e.g., after B<MTBSF>, "
10495 "B<MTBSS>, or B<MTSEEK>)."
10499 #: build/C/man4/st.4:804
10501 msgid "MTIOCPOS \\(em get tape position"
10504 #. type: Plain text
10505 #: build/C/man4/st.4:818
10507 "This request takes an argument of type I<(struct mtpos *)> and reports the "
10508 "drive's notion of the current tape block number, which is not the same as "
10509 "I<mt_blkno> returned by B<MTIOCGET>. This drive must be a SCSI-2 drive that "
10510 "supports the B<READ POSITION> command (device-specific address) or a "
10511 "Tandberg-compatible SCSI-1 drive (Tandberg, Archive Viper, Wangtek, ... )."
10514 #. type: Plain text
10515 #: build/C/man4/st.4:825
10518 "/* structure for MTIOCPOS - mag tape get position command */\n"
10520 " long mt_blkno; /* current block number */\n"
10524 #. type: Plain text
10525 #: build/C/man4/st.4:834
10527 "An attempt was made to write or erase a write-protected tape. (This error "
10528 "is not detected during B<open>(2).)"
10532 #: build/C/man4/st.4:834
10537 #. type: Plain text
10538 #: build/C/man4/st.4:838
10539 msgid "The device is already in use or the driver was unable to allocate a buffer."
10542 #. type: Plain text
10543 #: build/C/man4/st.4:842
10544 msgid "The command parameters point to memory not belonging to the calling process."
10547 #. type: Plain text
10548 #: build/C/man4/st.4:847
10550 "An B<ioctl>(2) had an invalid argument, or a requested block size was "
10555 #: build/C/man4/st.4:847
10560 #. type: Plain text
10561 #: build/C/man4/st.4:850
10562 msgid "The requested operation could not be completed."
10565 #. type: Plain text
10566 #: build/C/man4/st.4:857
10568 "The byte count in B<read>(2) is smaller than the next physical block on the "
10569 "tape. (Before 2.2.18 and 2.4.0-test6 the extra bytes have been silently "
10573 #. type: Plain text
10574 #: build/C/man4/st.4:861
10576 "A write operation could not be completed because the tape reached "
10581 #: build/C/man4/st.4:861 build/C/man2/syslog.2:278
10586 #. type: Plain text
10587 #: build/C/man4/st.4:865
10588 msgid "Unknown B<ioctl>(2)."
10592 #: build/C/man4/st.4:865
10597 #. type: Plain text
10598 #: build/C/man4/st.4:868
10599 msgid "During opening, the tape device does not exist."
10603 #: build/C/man4/st.4:868
10605 msgid "B<EOVERFLOW>"
10608 #. type: Plain text
10609 #: build/C/man4/st.4:872
10611 "An attempt was made to read or write a variable-length block that is larger "
10612 "than the driver's internal buffer."
10615 #. type: Plain text
10616 #: build/C/man4/st.4:879
10618 "Open is attempted with B<O_WRONLY> or B<O_RDWR> when the tape in the drive "
10619 "is write-protected."
10623 #: build/C/man4/st.4:880
10625 msgid "I</dev/st*>"
10628 #. type: Plain text
10629 #: build/C/man4/st.4:883
10630 msgid "the auto-rewind SCSI tape devices"
10634 #: build/C/man4/st.4:883
10636 msgid "I</dev/nst*>"
10640 #. The driver has been written by Kai M\(:akisara (Kai.Makisara@metla.fi)
10641 #. starting from a driver written by Dwayne Forsyth.
10643 #. people have also contributed to the driver.
10644 #. type: Plain text
10645 #: build/C/man4/st.4:891
10646 msgid "the nonrewind SCSI tape devices"
10649 #. type: Plain text
10650 #: build/C/man4/st.4:912
10652 "When exchanging data between systems, both systems have to agree on the "
10653 "physical tape block size. The parameters of a drive after startup are often "
10654 "not the ones most operating systems use with these devices. Most systems "
10655 "use drives in variable-block mode if the drive supports that mode. This "
10656 "applies to most modern drives, including DATs, 8mm helical scan drives, "
10657 "DLTs, etc. It may be advisable to use these drives in variable-block mode "
10658 "also in Linux (i.e., use B<MTSETBLK> or B<MTSETDEFBLK> at system startup to "
10659 "set the mode), at least when exchanging data with a foreign system. The "
10660 "drawback of this is that a fairly large tape block size has to be used to "
10661 "get acceptable data transfer rates on the SCSI bus."
10664 #. type: Plain text
10665 #: build/C/man4/st.4:919
10667 "Many programs (e.g., B<tar>(1)) allow the user to specify the blocking "
10668 "factor on the command line. Note that this determines the physical block "
10669 "size on tape only in variable-block mode."
10672 #. type: Plain text
10673 #: build/C/man4/st.4:926
10675 "In order to use SCSI tape drives, the basic SCSI driver, a SCSI-adapter "
10676 "driver and the SCSI tape driver must be either configured into the kernel or "
10677 "loaded as modules. If the SCSI-tape driver is not present, the drive is "
10678 "recognized but the tape support described in this page is not available."
10681 #. type: Plain text
10682 #: build/C/man4/st.4:931
10684 "The driver writes error messages to the console/log. The SENSE codes "
10685 "written into some messages are automatically translated to text if verbose "
10686 "SCSI messages are enabled in kernel configuration."
10690 #. Copyright \(co 1995 Robert K. Nichols.
10692 #. Copyright \(co 1999-2005 Kai M\(:akisara.
10694 #. %%%LICENSE_START(VERBATIM)
10695 #. Permission is granted to make and distribute verbatim copies of this
10696 #. manual provided the copyright notice and this permission notice are
10697 #. preserved on all copies.
10698 #. Additional permissions are contained in the header of the source file.
10699 #. type: Plain text
10700 #: build/C/man4/st.4:954
10702 "The driver's internal buffering allows good throughput in fixed-block mode "
10703 "also with small B<read>(2) and B<write>(2) byte counts. With direct "
10704 "transfers this is not possible and may cause a surprise when moving to the "
10705 "2.6 kernel. The solution is to tell the software to use larger transfers "
10706 "(often telling it to use larger blocks). If this is not possible, direct "
10707 "transfers can be disabled."
10710 #. type: Plain text
10711 #: build/C/man4/st.4:956
10715 #. type: Plain text
10716 #: build/C/man4/st.4:964
10718 "The file I<drivers/scsi/README.st> or I<Documentation/scsi/st.txt> (kernel "
10719 "E<gt>= 2.6) in the Linux kernel source tree contains the most recent "
10720 "information about the driver and its configuration possibilities"
10724 #: build/C/man3/stdarg.3:43
10729 #. type: Plain text
10730 #: build/C/man3/stdarg.3:46
10731 msgid "stdarg, va_start, va_arg, va_end, va_copy - variable argument lists"
10734 #. type: Plain text
10735 #: build/C/man3/stdarg.3:48 build/C/man3/syslog.3:49
10736 msgid "B<#include E<lt>stdarg.hE<gt>>"
10739 #. type: Plain text
10740 #: build/C/man3/stdarg.3:50
10741 msgid "B<void va_start(va_list >I<ap>B<, >I<last>B<);>"
10744 #. type: Plain text
10745 #: build/C/man3/stdarg.3:52
10746 msgid "I<type>B< va_arg(va_list >I<ap>B<, >I<type>B<);>"
10749 #. type: Plain text
10750 #: build/C/man3/stdarg.3:54
10751 msgid "B<void va_end(va_list >I<ap>B<);>"
10754 #. type: Plain text
10755 #: build/C/man3/stdarg.3:56
10756 msgid "B<void va_copy(va_list >I<dest>B<, va_list >I<src>B<);>"
10759 #. type: Plain text
10760 #: build/C/man3/stdarg.3:65
10762 "A function may be called with a varying number of arguments of varying "
10763 "types. The include file I<E<lt>stdarg.hE<gt>> declares a type I<va_list> "
10764 "and defines three macros for stepping through a list of arguments whose "
10765 "number and types are not known to the called function."
10768 #. type: Plain text
10769 #: build/C/man3/stdarg.3:73
10771 "The called function must declare an object of type I<va_list> which is used "
10772 "by the macros B<va_start>(), B<va_arg>(), and B<va_end>()."
10776 #: build/C/man3/stdarg.3:73
10781 #. type: Plain text
10782 #: build/C/man3/stdarg.3:83
10784 "The B<va_start>() macro initializes I<ap> for subsequent use by B<va_arg>() "
10785 "and B<va_end>(), and must be called first."
10788 #. type: Plain text
10789 #: build/C/man3/stdarg.3:88
10791 "The argument I<last> is the name of the last argument before the variable "
10792 "argument list, that is, the last argument of which the calling function "
10796 #. type: Plain text
10797 #: build/C/man3/stdarg.3:93
10799 "Because the address of this argument may be used in the B<va_start>() "
10800 "macro, it should not be declared as a register variable, or as a function or "
10805 #: build/C/man3/stdarg.3:93
10810 #. type: Plain text
10811 #: build/C/man3/stdarg.3:115
10813 "The B<va_arg>() macro expands to an expression that has the type and value "
10814 "of the next argument in the call. The argument I<ap> is the I<va_list> "
10815 "I<ap> initialized by B<va_start>(). Each call to B<va_arg>() modifies "
10816 "I<ap> so that the next call returns the next argument. The argument I<type> "
10817 "is a type name specified so that the type of a pointer to an object that has "
10818 "the specified type can be obtained simply by adding a * to I<type>."
10821 #. type: Plain text
10822 #: build/C/man3/stdarg.3:123
10824 "The first use of the B<va_arg>() macro after that of the B<va_start>() "
10825 "macro returns the argument after I<last>. Successive invocations return the "
10826 "values of the remaining arguments."
10829 #. type: Plain text
10830 #: build/C/man3/stdarg.3:128
10832 "If there is no next argument, or if I<type> is not compatible with the type "
10833 "of the actual next argument (as promoted according to the default argument "
10834 "promotions), random errors will occur."
10837 #. type: Plain text
10838 #: build/C/man3/stdarg.3:136
10840 "If I<ap> is passed to a function that uses B<va_arg(>I<ap>B<,>I<type>B<)> "
10841 "then the value of I<ap> is undefined after the return of that function."
10845 #: build/C/man3/stdarg.3:136
10850 #. type: Plain text
10851 #: build/C/man3/stdarg.3:155
10853 "Each invocation of B<va_start>() must be matched by a corresponding "
10854 "invocation of B<va_end>() in the same function. After the call "
10855 "B<va_end(>I<ap>B<)> the variable I<ap> is undefined. Multiple traversals of "
10856 "the list, each bracketed by B<va_start>() and B<va_end>() are possible. "
10857 "B<va_end>() may be a macro or a function."
10861 #: build/C/man3/stdarg.3:155
10866 #. type: Plain text
10867 #: build/C/man3/stdarg.3:172
10869 "The B<va_copy>() macro copies the (previously initialized) variable "
10870 "argument list I<src> to I<dest>. The behavior is as if B<va_start>() were "
10871 "applied to I<dest> with the same I<last> argument, followed by the same "
10872 "number of B<va_arg>() invocations that was used to reach the current state "
10876 #. Proposal from clive@demon.net, 1997-02-28
10877 #. type: Plain text
10878 #: build/C/man3/stdarg.3:179
10880 "An obvious implementation would have a I<va_list> be a pointer to the stack "
10881 "frame of the variadic function. In such a setup (by far the most common) "
10882 "there seems nothing against an assignment"
10885 #. type: Plain text
10886 #: build/C/man3/stdarg.3:183
10888 msgid "va_list aq = ap;\n"
10891 #. type: Plain text
10892 #: build/C/man3/stdarg.3:188
10894 "Unfortunately, there are also systems that make it an array of pointers (of "
10895 "length 1), and there one needs"
10898 #. type: Plain text
10899 #: build/C/man3/stdarg.3:193
10906 #. type: Plain text
10907 #: build/C/man3/stdarg.3:209
10909 "Finally, on systems where arguments are passed in registers, it may be "
10910 "necessary for B<va_start>() to allocate memory, store the arguments there, "
10911 "and also an indication of which argument is next, so that B<va_arg>() can "
10912 "step through the list. Now B<va_end>() can free the allocated memory "
10913 "again. To accommodate this situation, C99 adds a macro B<va_copy>(), so "
10914 "that the above assignment can be replaced by"
10917 #. type: Plain text
10918 #: build/C/man3/stdarg.3:216
10922 "va_copy(aq, ap);\n"
10927 #. type: Plain text
10928 #: build/C/man3/stdarg.3:229
10930 "Each invocation of B<va_copy>() must be matched by a corresponding "
10931 "invocation of B<va_end>() in the same function. Some systems that do not "
10932 "supply B<va_copy>() have B<__va_copy> instead, since that was the name used "
10933 "in the draft proposal."
10936 #. type: Plain text
10937 #: build/C/man3/stdarg.3:239
10939 "The B<va_start>(), B<va_arg>(), and B<va_end>() macros conform to C89. C99 "
10940 "defines the B<va_copy>() macro."
10943 #. type: Plain text
10944 #: build/C/man3/stdarg.3:245
10946 "These macros are I<not> compatible with the historic macros they replace. A "
10947 "backward-compatible version can be found in the include file "
10948 "I<E<lt>varargs.hE<gt>>."
10951 #. type: Plain text
10952 #: build/C/man3/stdarg.3:247
10953 msgid "The historic setup is:"
10956 #. type: Plain text
10957 #: build/C/man3/stdarg.3:251
10959 msgid "#include E<lt>varargs.hE<gt>\n"
10962 #. type: Plain text
10963 #: build/C/man3/stdarg.3:257
10973 #. type: Plain text
10974 #: build/C/man3/stdarg.3:266
10980 " x = va_arg(ap, type);\n"
10987 #. type: Plain text
10988 #: build/C/man3/stdarg.3:275
10990 "On some systems, I<va_end> contains a closing \\(aq}\\(aq matching a "
10991 "\\(aq{\\(aq in I<va_start>, so that both macros must occur in the same "
10992 "function, and in a way that allows this."
10995 #. type: Plain text
10996 #: build/C/man3/stdarg.3:291
10998 "Unlike the B<varargs> macros, the B<stdarg> macros do not permit programmers "
10999 "to code a function with no fixed arguments. This problem generates work "
11000 "mainly when converting B<varargs> code to B<stdarg> code, but it also "
11001 "creates difficulties for variadic functions that wish to pass all of their "
11002 "arguments on to a function that takes a I<va_list> argument, such as "
11006 #. type: Plain text
11007 #: build/C/man3/stdarg.3:296
11009 "The function I<foo> takes a string of format characters and prints out the "
11010 "argument associated with each format character based on the type."
11013 #. type: Plain text
11014 #: build/C/man3/stdarg.3:300
11017 "#include E<lt>stdio.hE<gt>\n"
11018 "#include E<lt>stdarg.hE<gt>\n"
11021 #. type: Plain text
11022 #: build/C/man3/stdarg.3:307
11026 "foo(char *fmt, ...)\n"
11033 #. type: Plain text
11034 #: build/C/man3/stdarg.3:328
11037 " va_start(ap, fmt);\n"
11039 " switch (*fmt++) {\n"
11040 " case \\(aqs\\(aq: /* string */\n"
11041 " s = va_arg(ap, char *);\n"
11042 " printf(\"string %s\\en\", s);\n"
11044 " case \\(aqd\\(aq: /* int */\n"
11045 " d = va_arg(ap, int);\n"
11046 " printf(\"int %d\\en\", d);\n"
11048 " case \\(aqc\\(aq: /* char */\n"
11049 " /* need a cast here since va_arg only\n"
11050 " takes fully promoted types */\n"
11051 " c = (char) va_arg(ap, int);\n"
11052 " printf(\"char %c\\en\", c);\n"
11060 #: build/C/man2/syslog.2:31 build/C/man3/syslog.3:36
11066 #: build/C/man2/syslog.2:31
11071 #. type: Plain text
11072 #: build/C/man2/syslog.2:35
11074 "syslog, klogctl - read and/or clear kernel message ring buffer; set "
11078 #. type: Plain text
11079 #: build/C/man2/syslog.2:39
11082 "B<int syslog(int >I<type>B<, char *>I<bufp>B<, int >I<len>B<);>\n"
11083 "B</* No wrapper provided in glibc */>\n"
11086 #. type: Plain text
11087 #: build/C/man2/syslog.2:41
11089 msgid "/* The glibc interface */\n"
11092 #. type: Plain text
11093 #: build/C/man2/syslog.2:43
11095 msgid "B<#include E<lt>sys/klog.hE<gt>>\n"
11098 #. type: Plain text
11099 #: build/C/man2/syslog.2:45
11101 msgid "B<int klogctl(int >I<type>B<, char *>I<bufp>B<, int >I<len>B<);>\n"
11104 #. type: Plain text
11105 #: build/C/man2/syslog.2:57
11107 "If you need the C library function B<syslog>() (which talks to "
11108 "B<syslogd>(8)), then look at B<syslog>(3). The system call of this name is "
11109 "about controlling the kernel I<printk>() buffer, and the glibc wrapper "
11110 "function is called B<klogctl>()."
11114 #: build/C/man2/syslog.2:57
11116 msgid "The kernel log buffer"
11119 #. Under "General setup" ==> "Kernel log buffer size"
11120 #. For 2.6, precisely the option seems to have appeared in 2.5.55.
11121 #. type: Plain text
11122 #: build/C/man2/syslog.2:73
11124 "The kernel has a cyclic buffer of length B<LOG_BUF_LEN> in which messages "
11125 "given as arguments to the kernel function B<printk>() are stored "
11126 "(regardless of their loglevel). In early kernels, B<LOG_BUF_LEN> had the "
11127 "value 4096; from kernel 1.3.54, it was 8192; from kernel 2.1.113 it was "
11128 "16384; since 2.4.23/2.6 the value is a kernel configuration option "
11129 "(B<CONFIG_LOG_BUF_SHIFT>). In recent kernels the size can be queried with "
11130 "command type 10 (see below)."
11134 #: build/C/man2/syslog.2:73
11139 #. type: Plain text
11140 #: build/C/man2/syslog.2:80
11142 "The I<type> argument determines the action taken by this function. The list "
11143 "below specifies the values for I<type>. The symbolic names are defined in "
11144 "the kernel source, but are not exported to user space; you will either need "
11145 "to use the numbers, or define the names yourself."
11149 #: build/C/man2/syslog.2:80
11151 msgid "B<SYSLOG_ACTION_CLOSE> (0)"
11154 #. type: Plain text
11155 #: build/C/man2/syslog.2:84
11156 msgid "Close the log. Currently a NOP."
11160 #: build/C/man2/syslog.2:84
11162 msgid "B<SYSLOG_ACTION_OPEN> (1)"
11165 #. type: Plain text
11166 #: build/C/man2/syslog.2:88
11167 msgid "Open the log. Currently a NOP."
11171 #: build/C/man2/syslog.2:88
11173 msgid "B<SYSLOG_ACTION_READ> (2)"
11176 #. type: Plain text
11177 #: build/C/man2/syslog.2:100
11179 "Read from the log. The call waits until the kernel log buffer is nonempty, "
11180 "and then reads at most I<len> bytes into the buffer pointed to by I<bufp>. "
11181 "The call returns the number of bytes read. Bytes read from the log "
11182 "disappear from the log buffer: the information can only be read once. This "
11183 "is the function executed by the kernel when a user program reads "
11188 #: build/C/man2/syslog.2:100
11190 msgid "B<SYSLOG_ACTION_READ_ALL> (3)"
11193 #. type: Plain text
11194 #: build/C/man2/syslog.2:110
11196 "Read all messages remaining in the ring buffer, placing then in the buffer "
11197 "pointed to by I<bufp>. The call reads the last I<len> bytes from the log "
11198 "buffer (nondestructively), but will not read more than was written into the "
11199 "buffer since the last \"clear ring buffer\" command (see command 5 below)). "
11200 "The call returns the number of bytes read."
11204 #: build/C/man2/syslog.2:110
11206 msgid "B<SYSLOG_ACTION_READ_CLEAR> (4)"
11209 #. type: Plain text
11210 #: build/C/man2/syslog.2:116
11212 "Read and clear all messages remaining in the ring buffer. The call does "
11213 "precisely the same as for a I<type> of 3, but also executes the \"clear ring "
11214 "buffer\" command."
11218 #: build/C/man2/syslog.2:116
11220 msgid "B<SYSLOG_ACTION_CLEAR> (5)"
11223 #. type: Plain text
11224 #: build/C/man2/syslog.2:124
11226 "The call executes just the \"clear ring buffer\" command. The I<bufp> and "
11227 "I<len> arguments are ignored."
11230 #. type: Plain text
11231 #: build/C/man2/syslog.2:135
11233 "This command does not really clear the ring buffer. Rather, it sets a "
11234 "kernel bookkeeping variable that determines the results returned by commands "
11235 "3 (B<SYSLOG_ACTION_READ_ALL>) and 4 (B<SYSLOG_ACTION_READ_CLEAR>). This "
11236 "command has no effect on commands 2 (B<SYSLOG_ACTION_READ>) and 9 "
11237 "(B<SYSLOG_ACTION_SIZE_UNREAD>)."
11241 #: build/C/man2/syslog.2:135
11243 msgid "B<SYSLOG_ACTION_CONSOLE_OFF> (6)"
11246 #. type: Plain text
11247 #: build/C/man2/syslog.2:145
11249 "Disable printk to console. The call sets the console log level to the "
11250 "minimum, so that no messages are printed to the console. The I<bufp> and "
11251 "I<len> arguments are ignored."
11255 #: build/C/man2/syslog.2:145
11257 msgid "B<SYSLOG_ACTION_CONSOLE_ON> (7)"
11260 #. type: Plain text
11261 #: build/C/man2/syslog.2:154
11263 "The call sets the console log level to the default, so that messages are "
11264 "printed to the console. The I<bufp> and I<len> arguments are ignored."
11268 #: build/C/man2/syslog.2:154
11270 msgid "B<SYSLOG_ACTION_CONSOLE_LEVEL> (8)"
11273 #. type: Plain text
11274 #: build/C/man2/syslog.2:165
11276 "The call sets the console log level to the value given in I<len>, which must "
11277 "be an integer between 1 and 8 (inclusive). See the B<loglevel> section for "
11278 "details. The I<bufp> argument is ignored."
11282 #: build/C/man2/syslog.2:165
11284 msgid "B<SYSLOG_ACTION_SIZE_UNREAD> (9) (since Linux 2.4.10)"
11287 #. type: Plain text
11288 #: build/C/man2/syslog.2:176
11290 "The call returns the number of bytes currently available to be read from the "
11291 "kernel log buffer via command 2 (B<SYSLOG_ACTION_READ>). The I<bufp> and "
11292 "I<len> arguments are ignored."
11296 #: build/C/man2/syslog.2:176
11298 msgid "B<SYSLOG_ACTION_SIZE_BUFFER> (10) (since Linux 2.6.6)"
11301 #. type: Plain text
11302 #: build/C/man2/syslog.2:184
11304 "This command returns the total size of the kernel log buffer. The I<bufp> "
11305 "and I<len> arguments are ignored."
11308 #. type: Plain text
11309 #: build/C/man2/syslog.2:201
11311 "All commands except 3 and 10 require privilege. In Linux kernels before "
11312 "2.6.37, command types 3 and 10 are allowed to unprivileged processes; since "
11313 "Linux 2.6.37, these commands are allowed to unprivileged processes only if "
11314 "I</proc/sys/kernel/dmesg_restrict> has the value 0. Before Linux 2.6.37, "
11315 "\"privileged\" means that the caller has the B<CAP_SYS_ADMIN> capability. "
11316 "Since Linux 2.6.37, \"privileged\" means that the caller has either the "
11317 "B<CAP_SYS_ADMIN> capability (now deprecated for this purpose) or the (new) "
11318 "B<CAP_SYSLOG> capability."
11322 #: build/C/man2/syslog.2:201
11324 msgid "The loglevel"
11327 #. type: Plain text
11328 #: build/C/man2/syslog.2:223
11330 "The kernel routine B<printk>() will only print a message on the console, if "
11331 "it has a loglevel less than the value of the variable I<console_loglevel>. "
11332 "This variable initially has the value B<DEFAULT_CONSOLE_LOGLEVEL> (7), but "
11333 "is set to 10 if the kernel command line contains the word \"debug\", and to "
11334 "15 in case of a kernel fault (the 10 and 15 are just silly, and equivalent "
11335 "to 8). This variable is set (to a value in the range 1-8) by a B<syslog>() "
11336 "call with a I<type> of 8. Calls to B<syslog>() with I<type> equal to 6 or "
11337 "7 set the variable to 1 (kernel panics only) or 7 (all except debugging "
11338 "messages), respectively."
11341 #. type: Plain text
11342 #: build/C/man2/syslog.2:233
11344 "Every text line in a message has its own loglevel. This level is "
11345 "I<DEFAULT_MESSAGE_LOGLEVEL - 1> (6) unless the line starts with E<lt>dE<gt> "
11346 "where I<d> is a digit in the range 1-7, in which case the level is I<d>. "
11347 "The conventional meaning of the loglevel is defined in "
11348 "I<E<lt>linux/kernel.hE<gt>> as follows:"
11351 #. type: Plain text
11352 #: build/C/man2/syslog.2:243
11355 "#define KERN_EMERG \"E<lt>0E<gt>\" /* system is unusable "
11357 "#define KERN_ALERT \"E<lt>1E<gt>\" /* action must be taken immediately "
11359 "#define KERN_CRIT \"E<lt>2E<gt>\" /* critical conditions "
11361 "#define KERN_ERR \"E<lt>3E<gt>\" /* error conditions "
11363 "#define KERN_WARNING \"E<lt>4E<gt>\" /* warning conditions "
11365 "#define KERN_NOTICE \"E<lt>5E<gt>\" /* normal but significant condition "
11367 "#define KERN_INFO \"E<lt>6E<gt>\" /* informational "
11369 "#define KERN_DEBUG \"E<lt>7E<gt>\" /* debug-level messages "
11373 #. type: Plain text
11374 #: build/C/man2/syslog.2:257
11376 "For I<type> equal to 2, 3, or 4, a successful call to B<syslog>() returns "
11377 "the number of bytes read. For I<type> 9, B<syslog>() returns the number of "
11378 "bytes currently available to be read on the kernel log buffer. For I<type> "
11379 "10, B<syslog>() returns the total size of the kernel log buffer. For other "
11380 "values of I<type>, 0 is returned on success."
11383 #. type: Plain text
11384 #: build/C/man2/syslog.2:260
11385 msgid "In case of error, -1 is returned, and I<errno> is set to indicate the error."
11388 #. type: Plain text
11389 #: build/C/man2/syslog.2:278
11391 "Bad arguments (e.g., bad I<type>; or for I<type> 2, 3, or 4, I<buf> is NULL, "
11392 "or I<len> is less than zero; or for I<type> 8, the I<level> is outside the "
11396 #. type: Plain text
11397 #: build/C/man2/syslog.2:285
11399 "This B<syslog>() system call is not available, because the kernel was "
11400 "compiled with the B<CONFIG_PRINTK> kernel-configuration option disabled."
11403 #. type: Plain text
11404 #: build/C/man2/syslog.2:294
11406 "An attempt was made to change console_loglevel or clear the kernel message "
11407 "ring buffer by a process without sufficient privilege (more precisely: "
11408 "without the B<CAP_SYS_ADMIN> or B<CAP_SYSLOG> capability)."
11412 #: build/C/man2/syslog.2:294
11414 msgid "B<ERESTARTSYS>"
11417 #. type: Plain text
11418 #: build/C/man2/syslog.2:298
11420 "System call was interrupted by a signal; nothing was read. (This can be "
11421 "seen only during a trace.)"
11424 #. type: Plain text
11425 #: build/C/man2/syslog.2:301
11427 "This system call is Linux-specific and should not be used in programs "
11428 "intended to be portable."
11431 #. In libc4 and libc5 the number of this call was defined by
11433 #. In glibc 2.0 the syscall is baptized
11435 #. type: Plain text
11436 #: build/C/man2/syslog.2:309
11438 "From the very start people noted that it is unfortunate that a system call "
11439 "and a library routine of the same name are entirely different animals."
11442 #. type: Plain text
11443 #: build/C/man2/syslog.2:312
11444 msgid "B<syslog>(3), B<capabilities>(7)"
11448 #: build/C/man3/syslog.3:36
11453 #. type: Plain text
11454 #: build/C/man3/syslog.3:39
11455 msgid "closelog, openlog, syslog, vsyslog - send messages to the system logger"
11458 #. type: Plain text
11459 #: build/C/man3/syslog.3:41
11460 msgid "B<#include E<lt>syslog.hE<gt>>"
11463 #. type: Plain text
11464 #: build/C/man3/syslog.3:43
11466 "B<void openlog(const char *>I<ident>B<, int >I<option>B<, int "
11467 ">I<facility>B<);>"
11470 #. type: Plain text
11471 #: build/C/man3/syslog.3:45
11472 msgid "B<void syslog(int >I<priority>B<, const char *>I<format>B<, ...);>"
11475 #. type: Plain text
11476 #: build/C/man3/syslog.3:47
11477 msgid "B<void closelog(void);>"
11480 #. type: Plain text
11481 #: build/C/man3/syslog.3:51
11483 "B<void vsyslog(int >I<priority>B<, const char *>I<format>B<, va_list "
11487 #. type: Plain text
11488 #: build/C/man3/syslog.3:59
11489 msgid "B<vsyslog>(): _BSD_SOURCE"
11492 #. type: Plain text
11493 #: build/C/man3/syslog.3:65
11495 "B<closelog>() closes the descriptor being used to write to the system "
11496 "logger. The use of B<closelog>() is optional."
11499 #. type: Plain text
11500 #: build/C/man3/syslog.3:77
11502 "B<openlog>() opens a connection to the system logger for a program. The "
11503 "string pointed to by I<ident> is prepended to every message, and is "
11504 "typically set to the program name. If I<ident> is NULL, the program name is "
11505 "used. (POSIX.1-2008 does not specify the behavior when I<ident> is NULL.)"
11508 #. type: Plain text
11509 #: build/C/man3/syslog.3:101
11511 "The I<option> argument specifies flags which control the operation of "
11512 "B<openlog>() and subsequent calls to B<syslog>(). The I<facility> argument "
11513 "establishes a default to be used if none is specified in subsequent calls to "
11514 "B<syslog>(). Values for I<option> and I<facility> are given below. The use "
11515 "of B<openlog>() is optional; it will automatically be called by B<syslog>() "
11516 "if necessary, in which case I<ident> will default to NULL."
11519 #. type: Plain text
11520 #: build/C/man3/syslog.3:125
11522 "B<syslog>() generates a log message, which will be distributed by "
11523 "B<syslogd>(8). The I<priority> argument is formed by ORing the I<facility> "
11524 "and the I<level> values (explained below). The remaining arguments are a "
11525 "I<format>, as in B<printf>(3) and any arguments required by the I<format>, "
11526 "except that the two character sequence B<%m> will be replaced by the error "
11527 "message string I<strerror>(I<errno>). A trailing newline may be added if "
11531 #. type: Plain text
11532 #: build/C/man3/syslog.3:134
11534 "The function B<vsyslog>() performs the same task as B<syslog>() with the "
11535 "difference that it takes a set of arguments which have been obtained using "
11536 "the B<stdarg>(3) variable argument list macros."
11539 #. type: Plain text
11540 #: build/C/man3/syslog.3:137
11542 "The subsections below list the parameters used to set the values of "
11543 "I<option>,I< facility>, and I<priority>."
11547 #: build/C/man3/syslog.3:137
11552 #. type: Plain text
11553 #: build/C/man3/syslog.3:143
11554 msgid "The I<option> argument to B<openlog>() is an OR of any of these:"
11558 #: build/C/man3/syslog.3:143
11560 msgid "B<LOG_CONS>"
11563 #. type: Plain text
11564 #: build/C/man3/syslog.3:147
11566 "Write directly to system console if there is an error while sending to "
11571 #: build/C/man3/syslog.3:147
11573 msgid "B<LOG_NDELAY>"
11576 #. type: Plain text
11577 #: build/C/man3/syslog.3:151
11579 "Open the connection immediately (normally, the connection is opened when the "
11580 "first message is logged)."
11584 #: build/C/man3/syslog.3:151
11586 msgid "B<LOG_NOWAIT>"
11589 #. type: Plain text
11590 #: build/C/man3/syslog.3:157
11592 "Don't wait for child processes that may have been created while logging the "
11593 "message. (The GNU C library does not create a child process, so this option "
11594 "has no effect on Linux.)"
11598 #: build/C/man3/syslog.3:157
11600 msgid "B<LOG_ODELAY>"
11603 #. type: Plain text
11604 #: build/C/man3/syslog.3:165
11606 "The converse of B<LOG_NDELAY>; opening of the connection is delayed until "
11607 "B<syslog>() is called. (This is the default, and need not be specified.)"
11611 #: build/C/man3/syslog.3:165
11613 msgid "B<LOG_PERROR>"
11616 #. type: Plain text
11617 #: build/C/man3/syslog.3:169
11618 msgid "(Not in POSIX.1-2001 or POSIX.1-2008.) Print to I<stderr> as well."
11622 #: build/C/man3/syslog.3:169
11627 #. type: Plain text
11628 #: build/C/man3/syslog.3:172
11629 msgid "Include PID with each message."
11633 #: build/C/man3/syslog.3:172
11638 #. type: Plain text
11639 #: build/C/man3/syslog.3:178
11641 "The I<facility> argument is used to specify what type of program is logging "
11642 "the message. This lets the configuration file specify that messages from "
11643 "different facilities will be handled differently."
11647 #: build/C/man3/syslog.3:178
11649 msgid "B<LOG_AUTH>"
11652 #. type: Plain text
11653 #: build/C/man3/syslog.3:181
11654 msgid "security/authorization messages"
11658 #: build/C/man3/syslog.3:181
11660 msgid "B<LOG_AUTHPRIV>"
11663 #. type: Plain text
11664 #: build/C/man3/syslog.3:184
11665 msgid "security/authorization messages (private)"
11669 #: build/C/man3/syslog.3:184
11671 msgid "B<LOG_CRON>"
11674 #. type: Plain text
11675 #: build/C/man3/syslog.3:188
11676 msgid "clock daemon (B<cron> and B<at>)"
11680 #: build/C/man3/syslog.3:188
11682 msgid "B<LOG_DAEMON>"
11685 #. type: Plain text
11686 #: build/C/man3/syslog.3:191
11687 msgid "system daemons without separate facility value"
11691 #: build/C/man3/syslog.3:191
11696 #. type: Plain text
11697 #: build/C/man3/syslog.3:194
11702 #: build/C/man3/syslog.3:194
11704 msgid "B<LOG_KERN>"
11707 #. LOG_KERN has the value 0; if used as a facility, zero translates to:
11708 #. "use the default facility".
11709 #. type: Plain text
11710 #: build/C/man3/syslog.3:199
11711 msgid "kernel messages (these can't be generated from user processes)"
11715 #: build/C/man3/syslog.3:199
11717 msgid "B<LOG_LOCAL0> through B<LOG_LOCAL7>"
11720 #. type: Plain text
11721 #: build/C/man3/syslog.3:202
11722 msgid "reserved for local use"
11726 #: build/C/man3/syslog.3:202
11731 #. type: Plain text
11732 #: build/C/man3/syslog.3:205
11733 msgid "line printer subsystem"
11737 #: build/C/man3/syslog.3:205
11739 msgid "B<LOG_MAIL>"
11742 #. type: Plain text
11743 #: build/C/man3/syslog.3:208
11744 msgid "mail subsystem"
11748 #: build/C/man3/syslog.3:208
11750 msgid "B<LOG_NEWS>"
11753 #. type: Plain text
11754 #: build/C/man3/syslog.3:211
11755 msgid "USENET news subsystem"
11759 #: build/C/man3/syslog.3:211
11761 msgid "B<LOG_SYSLOG>"
11764 #. type: Plain text
11765 #: build/C/man3/syslog.3:215
11766 msgid "messages generated internally by B<syslogd>(8)"
11770 #: build/C/man3/syslog.3:215
11772 msgid "B<LOG_USER> (default)"
11775 #. type: Plain text
11776 #: build/C/man3/syslog.3:218
11777 msgid "generic user-level messages"
11781 #: build/C/man3/syslog.3:218
11783 msgid "B<LOG_UUCP>"
11786 #. type: Plain text
11787 #: build/C/man3/syslog.3:221
11788 msgid "UUCP subsystem"
11792 #: build/C/man3/syslog.3:221
11797 #. type: Plain text
11798 #: build/C/man3/syslog.3:224
11800 "This determines the importance of the message. The levels are, in order of "
11801 "decreasing importance:"
11805 #: build/C/man3/syslog.3:224
11807 msgid "B<LOG_EMERG>"
11810 #. type: Plain text
11811 #: build/C/man3/syslog.3:227
11812 msgid "system is unusable"
11816 #: build/C/man3/syslog.3:227
11818 msgid "B<LOG_ALERT>"
11821 #. type: Plain text
11822 #: build/C/man3/syslog.3:230
11823 msgid "action must be taken immediately"
11827 #: build/C/man3/syslog.3:230
11829 msgid "B<LOG_CRIT>"
11832 #. type: Plain text
11833 #: build/C/man3/syslog.3:233
11834 msgid "critical conditions"
11838 #: build/C/man3/syslog.3:233
11843 #. type: Plain text
11844 #: build/C/man3/syslog.3:236
11845 msgid "error conditions"
11849 #: build/C/man3/syslog.3:236
11851 msgid "B<LOG_WARNING>"
11854 #. type: Plain text
11855 #: build/C/man3/syslog.3:239
11856 msgid "warning conditions"
11860 #: build/C/man3/syslog.3:239
11862 msgid "B<LOG_NOTICE>"
11865 #. type: Plain text
11866 #: build/C/man3/syslog.3:242
11867 msgid "normal, but significant, condition"
11871 #: build/C/man3/syslog.3:242
11873 msgid "B<LOG_INFO>"
11876 #. type: Plain text
11877 #: build/C/man3/syslog.3:245
11878 msgid "informational message"
11882 #: build/C/man3/syslog.3:245
11884 msgid "B<LOG_DEBUG>"
11887 #. type: Plain text
11888 #: build/C/man3/syslog.3:248
11889 msgid "debug-level message"
11892 #. type: Plain text
11893 #: build/C/man3/syslog.3:252
11895 "The function B<setlogmask>(3) can be used to restrict logging to specified "
11902 #. function call appeared in 4.2BSD.
11903 #. 4.3BSD documents
11906 #. .BR closelog (),
11908 #. .BR setlogmask ().
11909 #. 4.3BSD-Reno also documents
11911 #. Of course early v* functions used the
11913 #. mechanism, which is not compatible with
11914 #. .IR <stdarg.h> .
11915 #. type: Plain text
11916 #: build/C/man3/syslog.3:296
11918 "The functions B<openlog>(), B<closelog>(), and B<syslog>() (but not "
11919 "B<vsyslog>()) are specified in SUSv2, POSIX.1-2001, and POSIX.1-2008. "
11920 "POSIX.1-2001 specifies only the B<LOG_USER> and B<LOG_LOCAL*> values for "
11921 "I<facility>. However, with the exception of B<LOG_AUTHPRIV> and B<LOG_FTP>, "
11922 "the other I<facility> values appear on most UNIX systems. The B<LOG_PERROR> "
11923 "value for I<option> is not specified by POSIX.1-2001 or POSIX.1-2008, but is "
11924 "available in most versions of UNIX."
11927 #. type: Plain text
11928 #: build/C/man3/syslog.3:308
11930 "The argument I<ident> in the call of B<openlog>() is probably stored "
11931 "as-is. Thus, if the string it points to is changed, B<syslog>() may start "
11932 "prepending the changed string, and if the string it points to ceases to "
11933 "exist, the results are undefined. Most portable is to use a string "
11937 #. type: Plain text
11938 #: build/C/man3/syslog.3:311
11940 "Never pass a string with user-supplied data as a format, use the following "
11944 #. type: Plain text
11945 #: build/C/man3/syslog.3:314
11947 msgid " syslog(priority, \"%s\", string);\n"
11950 #. type: Plain text
11951 #: build/C/man3/syslog.3:320
11952 msgid "B<logger>(1), B<setlogmask>(3), B<syslog.conf>(5), B<syslogd>(8)"
11956 #: build/C/man4/ttyS.4:26
11962 #: build/C/man4/ttyS.4:26
11967 #. type: Plain text
11968 #: build/C/man4/ttyS.4:29
11969 msgid "ttyS - serial terminal lines"
11972 #. type: Plain text
11973 #: build/C/man4/ttyS.4:31
11974 msgid "B<ttyS[0-3]> are character devices for the serial terminal lines."
11977 #. type: Plain text
11978 #: build/C/man4/ttyS.4:36
11979 msgid "mknod -m 660 /dev/ttyS0 c 4 64 # base address 0x3f8"
11982 #. type: Plain text
11983 #: build/C/man4/ttyS.4:38
11984 msgid "mknod -m 660 /dev/ttyS1 c 4 65 # base address 0x2f8"
11987 #. type: Plain text
11988 #: build/C/man4/ttyS.4:40
11989 msgid "mknod -m 660 /dev/ttyS2 c 4 66 # base address 0x3e8"
11992 #. type: Plain text
11993 #: build/C/man4/ttyS.4:42
11994 msgid "mknod -m 660 /dev/ttyS3 c 4 67 # base address 0x2e8"
11997 #. type: Plain text
11998 #: build/C/man4/ttyS.4:44
11999 msgid "chown root:tty /dev/ttyS[0-3]"
12002 #. type: Plain text
12003 #: build/C/man4/ttyS.4:47
12004 msgid "/dev/ttyS[0-3]"
12007 #. type: Plain text
12008 #: build/C/man4/ttyS.4:54
12010 "B<chown>(1), B<mknod>(1), B<tty>(4), B<agetty>(8), B<mingetty>(8), "
12015 #: build/C/man7/uri.7:48
12020 #. type: Plain text
12021 #: build/C/man7/uri.7:51
12022 msgid "uri, url, urn - uniform resource identifier (URI), including a URL or URN"
12025 #. type: Plain text
12026 #: build/C/man7/uri.7:55
12028 msgid "URI = [ absoluteURI | relativeURI ] [ \"#\" fragment ]\n"
12031 #. type: Plain text
12032 #: build/C/man7/uri.7:57
12034 msgid "absoluteURI = scheme \":\" ( hierarchical_part | opaque_part )\n"
12037 #. type: Plain text
12038 #: build/C/man7/uri.7:59
12040 msgid "relativeURI = ( net_path | absolute_path | relative_path ) [ \"?\" query ]\n"
12043 #. type: Plain text
12044 #: build/C/man7/uri.7:62
12047 "scheme = \"http\" | \"ftp\" | \"gopher\" | \"mailto\" | \"news\" | "
12049 " \"file\" | \"man\" | \"info\" | \"whatis\" | \"ldap\" | \"wais\" | "
12053 #. type: Plain text
12054 #: build/C/man7/uri.7:64
12056 msgid "hierarchical_part = ( net_path | absolute_path ) [ \"?\" query ]\n"
12059 #. type: Plain text
12060 #: build/C/man7/uri.7:66
12062 msgid "net_path = \"//\" authority [ absolute_path ]\n"
12065 #. type: Plain text
12066 #: build/C/man7/uri.7:68
12068 msgid "absolute_path = \"/\" path_segments\n"
12071 #. type: Plain text
12072 #: build/C/man7/uri.7:70
12074 msgid "relative_path = relative_segment [ absolute_path ]\n"
12077 #. type: Plain text
12078 #: build/C/man7/uri.7:82
12080 "A Uniform Resource Identifier (URI) is a short string of characters "
12081 "identifying an abstract or physical resource (for example, a web page). A "
12082 "Uniform Resource Locator (URL) is a URI that identifies a resource through "
12083 "its primary access mechanism (e.g., its network \"location\"), rather than "
12084 "by name or some other attribute of that resource. A Uniform Resource Name "
12085 "(URN) is a URI that must remain globally unique and persistent even when the "
12086 "resource ceases to exist or becomes unavailable."
12089 #. type: Plain text
12090 #: build/C/man7/uri.7:89
12092 "URIs are the standard way to name hypertext link destinations for tools such "
12093 "as web browsers. The string \"http://www.kernelnotes.org\" is a URL (and "
12094 "thus it is also a URI). Many people use the term URL loosely as a synonym "
12095 "for URI (though technically URLs are a subset of URIs)."
12098 #. type: Plain text
12099 #: build/C/man7/uri.7:105
12101 "URIs can be absolute or relative. An absolute identifier refers to a "
12102 "resource independent of context, while a relative identifier refers to a "
12103 "resource by describing the difference from the current context. Within a "
12104 "relative path reference, the complete path segments \".\" and \"..\" have "
12105 "special meanings: \"the current hierarchy level\" and \"the level above this "
12106 "hierarchy level\", respectively, just like they do in UNIX-like systems. A "
12107 "path segment which contains a colon character can't be used as the first "
12108 "segment of a relative URI path (e.g., \"this:that\"), because it would be "
12109 "mistaken for a scheme name; precede such segments with ./ (e.g., "
12110 "\"./this:that\"). Note that descendants of MS-DOS (e.g., Microsoft Windows) "
12111 "replace devicename colons with the vertical bar (\"|\") in URIs, so \"C:\" "
12115 #. type: Plain text
12116 #: build/C/man7/uri.7:109
12118 "A fragment identifier, if included, refers to a particular named portion "
12119 "(fragment) of a resource; text after a \\(aq#\\(aq identifies the fragment. "
12120 "A URI beginning with \\(aq#\\(aq refers to that fragment in the current "
12124 #. type: Plain text
12125 #: build/C/man7/uri.7:117
12127 "There are many different URI schemes, each with specific additional rules "
12128 "and meanings, but they are intentionally made to be as similar as possible. "
12129 "For example, many URL schemes permit the authority to be the following "
12130 "format, called here an I<ip_server> (square brackets show what's optional):"
12133 #. type: Plain text
12134 #: build/C/man7/uri.7:119
12135 msgid "I<ip_server = >[I<user> [ : I<password> ] @ ] I<host> [ : I<port>]"
12138 #. type: Plain text
12139 #: build/C/man7/uri.7:135
12141 "This format allows you to optionally insert a username, a user plus "
12142 "password, and/or a port number. The I<host> is the name of the host "
12143 "computer, either its name as determined by DNS or an IP address (numbers "
12144 "separated by periods). Thus the URI "
12145 "E<lt>http://fred:fredpassword@xyz.com:8080/E<gt> logs into a web server on "
12146 "host xyz.com as fred (using fredpassword) using port 8080. Avoid including "
12147 "a password in a URI if possible because of the many security risks of having "
12148 "a password written down. If the URL supplies a username but no password, "
12149 "and the remote server requests a password, the program interpreting the URL "
12150 "should request one from the user."
12153 #. type: Plain text
12154 #: build/C/man7/uri.7:140
12156 "Here are some of the most common schemes in use on UNIX-like systems that "
12157 "are understood by many tools. Note that many tools using URIs also have "
12158 "internal schemes or specialized schemes; see those tools' documentation for "
12159 "information on those schemes."
12162 #. type: Plain text
12163 #: build/C/man7/uri.7:142
12164 msgid "B<http - Web (HTTP) server>"
12167 #. type: Plain text
12168 #: build/C/man7/uri.7:144
12169 msgid "http://I<ip_server>/I<path>"
12172 #. type: Plain text
12173 #: build/C/man7/uri.7:146
12174 msgid "http://I<ip_server>/I<path>?I<query>"
12177 #. type: Plain text
12178 #: build/C/man7/uri.7:154
12180 "This is a URL accessing a web (HTTP) server. The default port is 80. If "
12181 "the path refers to a directory, the web server will choose what to return; "
12182 "usually if there is a file named \"index.html\" or \"index.htm\" its content "
12183 "is returned, otherwise, a list of the files in the current directory (with "
12184 "appropriate links) is generated and returned. An example is "
12185 "E<lt>http://lwn.netE<gt>."
12188 #. type: Plain text
12189 #: build/C/man7/uri.7:177
12191 "A query can be given in the archaic \"isindex\" format, consisting of a word "
12192 "or phrase and not including an equal sign (=). A query can also be in the "
12193 "longer \"GET\" format, which has one or more query entries of the form "
12194 "I<key>=I<value> separated by the ampersand character (&). Note that I<key> "
12195 "can be repeated more than once, though it's up to the web server and its "
12196 "application programs to determine if there's any meaning to that. There is "
12197 "an unfortunate interaction with HTML/XML/SGML and the GET query format; when "
12198 "such URIs with more than one key are embedded in SGML/XML documents "
12199 "(including HTML), the ampersand (&) has to be rewritten as &. Note that "
12200 "not all queries use this format; larger forms may be too long to store as a "
12201 "URI, so they use a different interaction mechanism (called POST) which does "
12202 "not include the data in the URI. See the Common Gateway Interface "
12203 "specification at E<.UR http://www.w3.org\\:/CGI> E<.UE> for more "
12207 #. type: Plain text
12208 #: build/C/man7/uri.7:179
12209 msgid "B<ftp - File Transfer Protocol (FTP)>"
12212 #. type: Plain text
12213 #: build/C/man7/uri.7:181
12214 msgid "ftp://I<ip_server>/I<path>"
12217 #. type: Plain text
12218 #: build/C/man7/uri.7:189
12220 "This is a URL accessing a file through the file transfer protocol (FTP). "
12221 "The default port (for control) is 21. If no username is included, the "
12222 "username \"anonymous\" is supplied, and in that case many clients provide as "
12223 "the password the requestor's Internet email address. An example is "
12224 "E<lt>ftp://ftp.is.co.za/rfc/rfc1808.txtE<gt>."
12227 #. type: Plain text
12228 #: build/C/man7/uri.7:191
12229 msgid "B<gopher - Gopher server>"
12232 #. type: Plain text
12233 #: build/C/man7/uri.7:193
12234 msgid "gopher://I<ip_server>/I<gophertype selector>"
12237 #. type: Plain text
12238 #: build/C/man7/uri.7:195
12239 msgid "gopher://I<ip_server>/I<gophertype selector>%09I<search>"
12242 #. type: Plain text
12243 #: build/C/man7/uri.7:197
12244 msgid "gopher://I<ip_server>/I<gophertype selector>%09I<search>%09I<gopher+_string>"
12247 #. type: Plain text
12248 #: build/C/man7/uri.7:207
12250 "The default gopher port is 70. I<gophertype> is a single-character field to "
12251 "denote the Gopher type of the resource to which the URL refers. The entire "
12252 "path may also be empty, in which case the delimiting \"/\" is also optional "
12253 "and the gophertype defaults to \"1\"."
12256 #. type: Plain text
12257 #: build/C/man7/uri.7:214
12259 "I<selector> is the Gopher selector string. In the Gopher protocol, Gopher "
12260 "selector strings are a sequence of octets which may contain any octets "
12261 "except 09 hexadecimal (US-ASCII HT or tab), 0A hexadecimal (US-ASCII "
12262 "character LF), and 0D (US-ASCII character CR)."
12265 #. type: Plain text
12266 #: build/C/man7/uri.7:216
12267 msgid "B<mailto - Email address>"
12270 #. type: Plain text
12271 #: build/C/man7/uri.7:218
12272 msgid "mailto:I<email-address>"
12275 #. type: Plain text
12276 #: build/C/man7/uri.7:226
12278 "This is an email address, usually of the form I<name>@I<hostname>. See "
12279 "B<mailaddr>(7) for more information on the correct format of an email "
12280 "address. Note that any % character must be rewritten as %25. An example is "
12281 "E<lt>mailto:dwheeler@dwheeler.comE<gt>."
12284 #. type: Plain text
12285 #: build/C/man7/uri.7:228
12286 msgid "B<news - Newsgroup or News message>"
12289 #. type: Plain text
12290 #: build/C/man7/uri.7:230
12291 msgid "news:I<newsgroup-name>"
12294 #. type: Plain text
12295 #: build/C/man7/uri.7:232
12296 msgid "news:I<message-id>"
12299 #. type: Plain text
12300 #: build/C/man7/uri.7:240
12302 "A I<newsgroup-name> is a period-delimited hierarchical name, such as "
12303 "\"comp.infosystems.www.misc\". If E<lt>newsgroup-nameE<gt> is \"*\" (as in "
12304 "E<lt>news:*E<gt>), it is used to refer to \"all available news groups\". An "
12305 "example is E<lt>news:comp.lang.adaE<gt>."
12308 #. type: Plain text
12309 #: build/C/man7/uri.7:252
12311 "A I<message-id> corresponds to the Message-ID of E<.UR "
12312 "http://www.ietf.org\\:/rfc\\:/rfc1036.txt> IETF RFC\\ 1036, E<.UE> without "
12313 "the enclosing \"E<lt>\" and \"E<gt>\"; it takes the form "
12314 "I<unique>@I<full_domain_name>. A message identifier may be distinguished "
12315 "from a news group name by the presence of the \"@\" character."
12318 #. type: Plain text
12319 #: build/C/man7/uri.7:254
12320 msgid "B<telnet - Telnet login>"
12323 #. type: Plain text
12324 #: build/C/man7/uri.7:256
12325 msgid "telnet://I<ip_server>/"
12328 #. type: Plain text
12329 #: build/C/man7/uri.7:262
12331 "The Telnet URL scheme is used to designate interactive text services that "
12332 "may be accessed by the Telnet protocol. The final \"/\" character may be "
12333 "omitted. The default port is 23. An example is "
12334 "E<lt>telnet://melvyl.ucop.edu/E<gt>."
12337 #. type: Plain text
12338 #: build/C/man7/uri.7:264
12339 msgid "B<file - Normal file>"
12342 #. type: Plain text
12343 #: build/C/man7/uri.7:266
12344 msgid "file://I<ip_server>/I<path_segments>"
12347 #. type: Plain text
12348 #: build/C/man7/uri.7:268
12349 msgid "file:I<path_segments>"
12352 #. type: Plain text
12353 #: build/C/man7/uri.7:285
12355 "This represents a file or directory accessible locally. As a special case, "
12356 "I<host> can be the string \"localhost\" or the empty string; this is "
12357 "interpreted as \"the machine from which the URL is being interpreted\". If "
12358 "the path is to a directory, the viewer should display the directory's "
12359 "contents with links to each containee; not all viewers currently do this. "
12360 "KDE supports generated files through the URL E<lt>file:/cgi-binE<gt>. If "
12361 "the given file isn't found, browser writers may want to try to expand the "
12362 "filename via filename globbing (see B<glob>(7) and B<glob>(3))."
12365 #. type: Plain text
12366 #: build/C/man7/uri.7:299
12368 "The second format (e.g., E<lt>file:/etc/passwdE<gt>) is a correct format "
12369 "for referring to a local file. However, older standards did not permit this "
12370 "format, and some programs don't recognize this as a URI. A more portable "
12371 "syntax is to use an empty string as the server name, for example, "
12372 "E<lt>file:///etc/passwdE<gt>; this form does the same thing and is easily "
12373 "recognized by pattern matchers and older programs as a URI. Note that if "
12374 "you really mean to say \"start from the current location,\" don't specify "
12375 "the scheme at all; use a relative address like E<lt>../test.txtE<gt>, which "
12376 "has the side-effect of being scheme-independent. An example of this scheme "
12377 "is E<lt>file:///etc/passwdE<gt>."
12380 #. type: Plain text
12381 #: build/C/man7/uri.7:301
12382 msgid "B<man - Man page documentation>"
12385 #. type: Plain text
12386 #: build/C/man7/uri.7:303
12387 msgid "man:I<command-name>"
12390 #. type: Plain text
12391 #: build/C/man7/uri.7:305
12392 msgid "man:I<command-name>(I<section>)"
12395 #. type: Plain text
12396 #: build/C/man7/uri.7:314
12398 "This refers to local online manual (man) reference pages. The command name "
12399 "can optionally be followed by a parenthesis and section number; see "
12400 "B<man>(7) for more information on the meaning of the section numbers. This "
12401 "URI scheme is unique to UNIX-like systems (such as Linux) and is not "
12402 "currently registered by the IETF. An example is E<lt>man:ls(1)E<gt>."
12405 #. type: Plain text
12406 #: build/C/man7/uri.7:316
12407 msgid "B<info - Info page documentation>"
12410 #. type: Plain text
12411 #: build/C/man7/uri.7:318
12412 msgid "info:I<virtual-filename>"
12415 #. type: Plain text
12416 #: build/C/man7/uri.7:320
12417 msgid "info:I<virtual-filename>#I<nodename>"
12420 #. type: Plain text
12421 #: build/C/man7/uri.7:322
12422 msgid "info:(I<virtual-filename>)"
12425 #. type: Plain text
12426 #: build/C/man7/uri.7:324
12427 msgid "info:(I<virtual-filename>)I<nodename>"
12430 #. type: Plain text
12431 #: build/C/man7/uri.7:343
12433 "This scheme refers to online info reference pages (generated from texinfo "
12434 "files), a documentation format used by programs such as the GNU tools. This "
12435 "URI scheme is unique to UNIX-like systems (such as Linux) and is not "
12436 "currently registered by the IETF. As of this writing, GNOME and KDE differ "
12437 "in their URI syntax and do not accept the other's syntax. The first two "
12438 "formats are the GNOME format; in nodenames all spaces are written as "
12439 "underscores. The second two formats are the KDE format; spaces in nodenames "
12440 "must be written as spaces, even though this is forbidden by the URI "
12441 "standards. It's hoped that in the future most tools will understand all of "
12442 "these formats and will always accept underscores for spaces in nodenames. "
12443 "In both GNOME and KDE, if the form without the nodename is used the nodename "
12444 "is assumed to be \"Top\". Examples of the GNOME format are "
12445 "E<lt>info:gccE<gt> and E<lt>info:gcc#G++_and_GCCE<gt>. Examples of the KDE "
12446 "format are E<lt>info:(gcc)E<gt> and E<lt>info:(gcc)G++ and GCCE<gt>."
12449 #. type: Plain text
12450 #: build/C/man7/uri.7:345
12451 msgid "B<whatis - Documentation search>"
12454 #. type: Plain text
12455 #: build/C/man7/uri.7:347
12456 msgid "whatis:I<string>"
12459 #. type: Plain text
12460 #: build/C/man7/uri.7:355
12462 "This scheme searches the database of short (one-line) descriptions of "
12463 "commands and returns a list of descriptions containing that string. Only "
12464 "complete word matches are returned. See B<whatis>(1). This URI scheme is "
12465 "unique to UNIX-like systems (such as Linux) and is not currently registered "
12469 #. type: Plain text
12470 #: build/C/man7/uri.7:357
12471 msgid "B<ghelp - GNOME help documentation>"
12474 #. type: Plain text
12475 #: build/C/man7/uri.7:359
12476 msgid "ghelp:I<name-of-application>"
12479 #. type: Plain text
12480 #: build/C/man7/uri.7:362
12482 "This loads GNOME help for the given application. Note that not much "
12483 "documentation currently exists in this format."
12486 #. type: Plain text
12487 #: build/C/man7/uri.7:364
12488 msgid "B<ldap - Lightweight Directory Access Protocol>"
12491 #. type: Plain text
12492 #: build/C/man7/uri.7:366
12493 msgid "ldap://I<hostport>"
12496 #. type: Plain text
12497 #: build/C/man7/uri.7:368
12498 msgid "ldap://I<hostport>/"
12501 #. type: Plain text
12502 #: build/C/man7/uri.7:370
12503 msgid "ldap://I<hostport>/I<dn>"
12506 #. type: Plain text
12507 #: build/C/man7/uri.7:372
12508 msgid "ldap://I<hostport>/I<dn>?I<attributes>"
12511 #. type: Plain text
12512 #: build/C/man7/uri.7:374
12513 msgid "ldap://I<hostport>/I<dn>?I<attributes>?I<scope>"
12516 #. type: Plain text
12517 #: build/C/man7/uri.7:376
12518 msgid "ldap://I<hostport>/I<dn>?I<attributes>?I<scope>?I<filter>"
12521 #. type: Plain text
12522 #: build/C/man7/uri.7:378
12523 msgid "ldap://I<hostport>/I<dn>?I<attributes>?I<scope>?I<filter>?I<extensions>"
12526 #. type: Plain text
12527 #: build/C/man7/uri.7:389
12529 "This scheme supports queries to the Lightweight Directory Access Protocol "
12530 "(LDAP), a protocol for querying a set of servers for hierarchically "
12531 "organized information (such as people and computing resources). See E<.UR "
12532 "http://www.ietf.org\\:/rfc\\:/rfc2255.txt> RFC\\ 2255 E<.UE> for more "
12533 "information on the LDAP URL scheme. The components of this URL are:"
12537 #: build/C/man7/uri.7:389
12542 #. type: Plain text
12543 #: build/C/man7/uri.7:394
12545 "the LDAP server to query, written as a hostname optionally followed by a "
12546 "colon and the port number. The default LDAP port is TCP port 389. If "
12547 "empty, the client determines which the LDAP server to use."
12551 #: build/C/man7/uri.7:394
12556 #. type: Plain text
12557 #: build/C/man7/uri.7:401
12559 "the LDAP Distinguished Name, which identifies the base object of the LDAP "
12560 "search (see E<.UR http://www.ietf.org\\:/rfc\\:/rfc2253.txt> RFC\\ 2253 "
12561 "E<.UE> section 3)."
12565 #: build/C/man7/uri.7:401
12570 #. type: Plain text
12571 #: build/C/man7/uri.7:405
12573 "a comma-separated list of attributes to be returned; see RFC\\ 2251 section "
12574 "4.1.5. If omitted, all attributes should be returned."
12578 #: build/C/man7/uri.7:405
12583 #. type: Plain text
12584 #: build/C/man7/uri.7:410
12586 "specifies the scope of the search, which can be one of \"base\" (for a base "
12587 "object search), \"one\" (for a one-level search), or \"sub\" (for a subtree "
12588 "search). If scope is omitted, \"base\" is assumed."
12592 #: build/C/man7/uri.7:410
12597 #. type: Plain text
12598 #: build/C/man7/uri.7:419
12600 "specifies the search filter (subset of entries to return). If omitted, all "
12601 "entries should be returned. See E<.UR "
12602 "http://www.ietf.org\\:/rfc\\:/rfc2254.txt> RFC\\ 2254 E<.UE> section 4."
12606 #: build/C/man7/uri.7:419
12611 #. type: Plain text
12612 #: build/C/man7/uri.7:425
12614 "a comma-separated list of type=value pairs, where the =value portion may be "
12615 "omitted for options not requiring it. An extension prefixed with a "
12616 "\\(aq!\\(aq is critical (must be supported to be valid), otherwise it is "
12617 "noncritical (optional)."
12620 #. type: Plain text
12621 #: build/C/man7/uri.7:429
12623 "LDAP queries are easiest to explain by example. Here's a query that asks "
12624 "ldap.itd.umich.edu for information about the University of Michigan in the "
12628 #. type: Plain text
12629 #: build/C/man7/uri.7:432
12631 msgid "ldap://ldap.itd.umich.edu/o=University%20of%20Michigan,c=US\n"
12634 #. type: Plain text
12635 #: build/C/man7/uri.7:435
12636 msgid "To just get its postal address attribute, request:"
12639 #. type: Plain text
12640 #: build/C/man7/uri.7:438
12642 msgid "ldap://ldap.itd.umich.edu/o=University%20of%20Michigan,c=US?postalAddress\n"
12645 #. type: Plain text
12646 #: build/C/man7/uri.7:442
12648 "To ask a host.com at port 6666 for information about the person with common "
12649 "name (cn) \"Babs Jensen\" at University of Michigan, request:"
12652 #. type: Plain text
12653 #: build/C/man7/uri.7:445
12655 msgid "ldap://host.com:6666/o=University%20of%20Michigan,c=US??sub?(cn=Babs%20Jensen)\n"
12658 #. type: Plain text
12659 #: build/C/man7/uri.7:448
12660 msgid "B<wais - Wide Area Information Servers>"
12663 #. type: Plain text
12664 #: build/C/man7/uri.7:450
12665 msgid "wais://I<hostport>/I<database>"
12668 #. type: Plain text
12669 #: build/C/man7/uri.7:452
12670 msgid "wais://I<hostport>/I<database>?I<search>"
12673 #. type: Plain text
12674 #: build/C/man7/uri.7:454
12675 msgid "wais://I<hostport>/I<database>/I<wtype>/I<wpath>"
12678 #. type: Plain text
12679 #: build/C/man7/uri.7:463
12681 "This scheme designates a WAIS database, search, or document (see E<.UR "
12682 "http://www.ietf.org\\:/rfc\\:/rfc1625.txt> IETF RFC\\ 1625 E<.UE> for more "
12683 "information on WAIS). Hostport is the hostname, optionally followed by a "
12684 "colon and port number (the default port number is 210)."
12687 #. type: Plain text
12688 #: build/C/man7/uri.7:473
12690 "The first form designates a WAIS database for searching. The second form "
12691 "designates a particular search of the WAIS database I<database>. The third "
12692 "form designates a particular document within a WAIS database to be "
12693 "retrieved. I<wtype> is the WAIS designation of the type of the object and "
12694 "I<wpath> is the WAIS document-id."
12697 #. type: Plain text
12698 #: build/C/man7/uri.7:475
12699 msgid "B<other schemes>"
12702 #. type: Plain text
12703 #: build/C/man7/uri.7:489
12705 "There are many other URI schemes. Most tools that accept URIs support a set "
12706 "of internal URIs (e.g., Mozilla has the about: scheme for internal "
12707 "information, and the GNOME help browser has the toc: scheme for various "
12708 "starting locations). There are many schemes that have been defined but are "
12709 "not as widely used at the current time (e.g., prospero). The nntp: scheme "
12710 "is deprecated in favor of the news: scheme. URNs are to be supported by the "
12711 "urn: scheme, with a hierarchical name space (e.g., urn:ietf:... would "
12712 "identify IETF documents); at this time URNs are not widely implemented. Not "
12713 "all tools support all schemes."
12717 #: build/C/man7/uri.7:489
12719 msgid "Character encoding"
12722 #. type: Plain text
12723 #: build/C/man7/uri.7:493
12725 "URIs use a limited number of characters so that they can be typed in and "
12726 "used in a variety of situations."
12729 #. type: Plain text
12730 #: build/C/man7/uri.7:497
12732 "The following characters are reserved, that is, they may appear in a URI but "
12733 "their use is limited to their reserved purpose (conflicting data must be "
12734 "escaped before forming the URI):"
12737 #. type: Plain text
12738 #: build/C/man7/uri.7:499
12740 msgid " ; / ? : @ & = + $ ,\n"
12743 #. type: Plain text
12744 #: build/C/man7/uri.7:505
12746 "Unreserved characters may be included in a URI. Unreserved characters "
12747 "include upper and lower case English letters, decimal digits, and the "
12748 "following limited set of punctuation marks and symbols:"
12751 #. type: Plain text
12752 #: build/C/man7/uri.7:507
12754 msgid " - _ . ! ~ * ' ( )\n"
12757 #. type: Plain text
12758 #: build/C/man7/uri.7:522
12760 "All other characters must be escaped. An escaped octet is encoded as a "
12761 "character triplet, consisting of the percent character \"%\" followed by the "
12762 "two hexadecimal digits representing the octet code (you can use upper or "
12763 "lower case letters for the hexadecimal digits). For example, a blank space "
12764 "must be escaped as \"%20\", a tab character as \"%09\", and the \"&\" as "
12765 "\"%26\". Because the percent \"%\" character always has the reserved "
12766 "purpose of being the escape indicator, it must be escaped as \"%25\". It is "
12767 "common practice to escape space characters as the plus symbol (+) in query "
12768 "text; this practice isn't uniformly defined in the relevant RFCs (which "
12769 "recommend %20 instead) but any tool accepting URIs with query text should be "
12770 "prepared for them. A URI is always shown in its \"escaped\" form."
12773 #. type: Plain text
12774 #: build/C/man7/uri.7:528
12776 "Unreserved characters can be escaped without changing the semantics of the "
12777 "URI, but this should not be done unless the URI is being used in a context "
12778 "that does not allow the unescaped character to appear. For example, \"%7e\" "
12779 "is sometimes used instead of \"~\" in an HTTP URL path, but the two are "
12780 "equivalent for an HTTP URL."
12783 #. type: Plain text
12784 #: build/C/man7/uri.7:532
12786 "For URIs which must handle characters outside the US ASCII character set, "
12787 "the HTML 4.01 specification (section B.2) and IETF RFC\\ 2718 (section "
12788 "2.2.5) recommend the following approach:"
12791 #. type: Plain text
12792 #: build/C/man7/uri.7:536
12794 "translate the character sequences into UTF-8 (IETF RFC\\ 2279)\\(emsee "
12795 "B<utf-8>(7)\\(emand then"
12798 #. type: Plain text
12799 #: build/C/man7/uri.7:539
12801 "use the URI escaping mechanism, that is, use the %HH encoding for unsafe "
12806 #: build/C/man7/uri.7:539
12808 msgid "Writing a URI"
12811 #. type: Plain text
12812 #: build/C/man7/uri.7:562
12814 "When written, URIs should be placed inside double quotes (e.g., "
12815 "\"http://www.kernelnotes.org\"), enclosed in angle brackets (e.g., "
12816 "E<lt>http://lwn.netE<gt>), or placed on a line by themselves. A warning for "
12817 "those who use double-quotes: B<never> move extraneous punctuation (such as "
12818 "the period ending a sentence or the comma in a list) inside a URI, since "
12819 "this will change the value of the URI. Instead, use angle brackets instead, "
12820 "or switch to a quoting system that never includes extraneous characters "
12821 "inside quotation marks. This latter system, called the 'new' or 'logical' "
12822 "quoting system by \"Hart's Rules\" and the \"Oxford Dictionary for Writers "
12823 "and Editors\", is preferred practice in Great Britain and hackers worldwide "
12824 "(see the Jargon File's section on Hacker Writing Style, E<.UR "
12825 "http://www.fwi.uva.nl\\:/~mes\\:/jargon\\:/h\\:/HackerWritingStyle.html> "
12826 "E<.UE ,> for more information). Older documents suggested inserting the "
12827 "prefix \"URL:\" just before the URI, but this form has never caught on."
12830 #. type: Plain text
12831 #: build/C/man7/uri.7:584
12833 "The URI syntax was designed to be unambiguous. However, as URIs have become "
12834 "commonplace, traditional media (television, radio, newspapers, billboards, "
12835 "etc.) have increasingly used abbreviated URI references consisting of only "
12836 "the authority and path portions of the identified resource (e.g., "
12837 "E<lt>www.w3.org/AddressingE<gt>). Such references are primarily intended "
12838 "for human interpretation rather than machine, with the assumption that "
12839 "context-based heuristics are sufficient to complete the URI (e.g., hostnames "
12840 "beginning with \"www\" are likely to have a URI prefix of \"http://\" and "
12841 "hostnames beginning with \"ftp\" likely to have a prefix of \"ftp://\"). "
12842 "Many client implementations heuristically resolve these references. Such "
12843 "heuristics may change over time, particularly when new schemes are "
12844 "introduced. Since an abbreviated URI has the same syntax as a relative URL "
12845 "path, abbreviated URI references cannot be used where relative URIs are "
12846 "permitted, and can only be used when there is no defined base (such as in "
12847 "dialog boxes). Don't use abbreviated URIs as hypertext links inside a "
12848 "document; use the standard format as described here."
12851 #. type: Plain text
12852 #: build/C/man7/uri.7:592
12854 "E<.UR http://www.ietf.org\\:/rfc\\:/rfc2396.txt> (IETF RFC\\ 2396) E<.UE ,> "
12855 "E<.UR http://www.w3.org\\:/TR\\:/REC-html40> (HTML 4.0) E<.UE .>"
12858 #. type: Plain text
12859 #: build/C/man7/uri.7:598
12861 "Any tool accepting URIs (e.g., a web browser) on a Linux system should be "
12862 "able to handle (directly or indirectly) all of the schemes described here, "
12863 "including the man: and info: schemes. Handling them by invoking some other "
12864 "program is fine and in fact encouraged."
12867 #. type: Plain text
12868 #: build/C/man7/uri.7:600
12869 msgid "Technically the fragment isn't part of the URI."
12872 #. type: Plain text
12873 #: build/C/man7/uri.7:609
12875 "For information on how to embed URIs (including URLs) in a data format, see "
12876 "documentation on that format. HTML uses the format E<lt>A "
12877 "HREF=\"I<uri>\"E<gt> I<text> E<lt>/AE<gt>. Texinfo files use the format "
12878 "@uref{I<uri>}. Man and mdoc have the recently added UR macro, or just "
12879 "include the URI in the text (viewers should be able to detect :// as part of "
12883 #. type: Plain text
12884 #: build/C/man7/uri.7:630
12886 "The GNOME and KDE desktop environments currently vary in the URIs they "
12887 "accept, in particular in their respective help browsers. To list man pages, "
12888 "GNOME uses E<lt>toc:manE<gt> while KDE uses E<lt>man:(index)E<gt>, and to "
12889 "list info pages, GNOME uses E<lt>toc:infoE<gt> while KDE uses "
12890 "E<lt>info:(dir)E<gt> (the author of this man page prefers the KDE approach "
12891 "here, though a more regular format would be even better). In general, KDE "
12892 "uses E<lt>file:/cgi-bin/E<gt> as a prefix to a set of generated files. KDE "
12893 "prefers documentation in HTML, accessed via the "
12894 "E<lt>file:/cgi-bin/helpindexE<gt>. GNOME prefers the ghelp scheme to store "
12895 "and find documentation. Neither browser handles file: references to "
12896 "directories at the time of this writing, making it difficult to refer to an "
12897 "entire directory with a browsable URI. As noted above, these environments "
12898 "differ in how they handle the info: scheme, probably the most important "
12899 "variation. It is expected that GNOME and KDE will converge to common URI "
12900 "formats, and a future version of this man page will describe the converged "
12901 "result. Efforts to aid this convergence are encouraged."
12905 #: build/C/man7/uri.7:630
12910 #. type: Plain text
12911 #: build/C/man7/uri.7:640
12913 "A URI does not in itself pose a security threat. There is no general "
12914 "guarantee that a URL, which at one time located a given resource, will "
12915 "continue to do so. Nor is there any guarantee that a URL will not locate a "
12916 "different resource at some later point in time; such a guarantee can only be "
12917 "obtained from the person(s) controlling that namespace and the resource in "
12921 #. type: Plain text
12922 #: build/C/man7/uri.7:655
12924 "It is sometimes possible to construct a URL such that an attempt to perform "
12925 "a seemingly harmless operation, such as the retrieval of an entity "
12926 "associated with the resource, will in fact cause a possibly damaging remote "
12927 "operation to occur. The unsafe URL is typically constructed by specifying a "
12928 "port number other than that reserved for the network protocol in question. "
12929 "The client unwittingly contacts a site that is in fact running a different "
12930 "protocol. The content of the URL contains instructions that, when "
12931 "interpreted according to this other protocol, cause an unexpected "
12932 "operation. An example has been the use of a gopher URL to cause an "
12933 "unintended or impersonating message to be sent via a SMTP server."
12936 #. type: Plain text
12937 #: build/C/man7/uri.7:659
12939 "Caution should be used when using any URL that specifies a port number other "
12940 "than the default for the protocol, especially when it is a number within the "
12944 #. type: Plain text
12945 #: build/C/man7/uri.7:667
12947 "Care should be taken when a URI contains escaped delimiters for a given "
12948 "protocol (for example, CR and LF characters for telnet protocols) that these "
12949 "are not unescaped before transmission. This might violate the protocol, but "
12950 "avoids the potential for such characters to be used to simulate an extra "
12951 "operation or parameter in that protocol, which might lead to an unexpected "
12952 "and possibly harmful remote operation to be performed."
12955 #. type: Plain text
12956 #: build/C/man7/uri.7:673
12958 "It is clearly unwise to use a URI that contains a password which is intended "
12959 "to be secret. In particular, the use of a password within the \"userinfo\" "
12960 "component of a URI is strongly recommended against except in those rare "
12961 "cases where the \"password\" parameter is intended to be public."
12964 #. type: Plain text
12965 #: build/C/man7/uri.7:695
12967 "Documentation may be placed in a variety of locations, so there currently "
12968 "isn't a good URI scheme for general online documentation in arbitrary "
12969 "formats. References of the form E<lt>file:///usr/doc/ZZZE<gt> don't work "
12970 "because different distributions and local installation requirements may "
12971 "place the files in different directories (it may be in /usr/doc, or "
12972 "/usr/local/doc, or /usr/share, or somewhere else). Also, the directory ZZZ "
12973 "usually changes when a version changes (though filename globbing could "
12974 "partially overcome this). Finally, using the file: scheme doesn't easily "
12975 "support people who dynamically load documentation from the Internet (instead "
12976 "of loading the files onto a local file system). A future URI scheme may be "
12977 "added (e.g., \"userdoc:\") to permit programs to include cross-references to "
12978 "more detailed documentation without having to know the exact location of "
12979 "that documentation. Alternatively, a future version of the file-system "
12980 "specification may specify file locations sufficiently so that the file: "
12981 "scheme will be able to locate documentation."
12984 #. type: Plain text
12985 #: build/C/man7/uri.7:698
12987 "Many programs and file formats don't include a way to incorporate or "
12988 "implement links using URIs."
12992 #. David A. Wheeler (dwheeler@dwheeler.com) wrote this man page.
12993 #. type: Plain text
12994 #: build/C/man7/uri.7:706
12996 "Many programs can't handle all of these different URI formats; there should "
12997 "be a standard mechanism to load an arbitrary URI that automatically detects "
12998 "the users' environment (e.g., text or graphics, desktop environment, local "
12999 "user preferences, and currently executing tools) and invokes the right tool "
13003 #. type: Plain text
13004 #: build/C/man7/uri.7:711
13005 msgid "B<lynx>(1), B<man2html>(1), B<mailaddr>(7), B<utf-8>(7)"
13008 #. type: Plain text
13009 #: build/C/man7/uri.7:715
13010 msgid "E<.UR http://www.ietf.org\\:/rfc\\:/rfc2255.txt> IETF RFC\\ 2255 E<.UE>"
13014 #: build/C/man4/vcs.4:29
13020 #: build/C/man4/vcs.4:29
13025 #. type: Plain text
13026 #: build/C/man4/vcs.4:32
13027 msgid "vcs, vcsa - virtual console memory"
13030 #. type: Plain text
13031 #: build/C/man4/vcs.4:37
13033 "I</dev/vcs0> is a character device with major number 7 and minor number 0, "
13034 "usually of mode 0644 and owner root.tty. It refers to the memory of the "
13035 "currently displayed virtual console terminal."
13038 #. type: Plain text
13039 #: build/C/man4/vcs.4:48
13041 "I</dev/vcs[1-63]> are character devices for virtual console terminals, they "
13042 "have major number 7 and minor number 1 to 63, usually mode 0644 and owner "
13043 "root.tty. I</dev/vcsa[0-63]> are the same, but using I<unsigned short>s (in "
13044 "host byte order) that include attributes, and prefixed with four bytes "
13045 "giving the screen dimensions and cursor position: I<lines>, I<columns>, "
13046 "I<x>, I<y>. (I<x> = I<y> = 0 at the top left corner of the screen.)"
13049 #. type: Plain text
13050 #: build/C/man4/vcs.4:60
13052 "When a 512-character font is loaded, the 9th bit position can be fetched by "
13053 "applying the B<ioctl>(2) B<VT_GETHIFONTMASK> operation (available in Linux "
13054 "kernels 2.6.18 and above) on I</dev/tty[1-63]>; the value is returned in "
13055 "the I<unsigned short> pointed to by the third B<ioctl>(2) argument."
13058 #. type: Plain text
13059 #: build/C/man4/vcs.4:67
13061 "These devices replace the screendump B<ioctl>(2) operations of "
13062 "B<console>(4), so the system administrator can control access using file "
13063 "system permissions."
13066 #. type: Plain text
13067 #: build/C/man4/vcs.4:69
13068 msgid "The devices for the first eight virtual consoles may be created by:"
13071 #. type: Plain text
13072 #: build/C/man4/vcs.4:76
13075 " for x in 0 1 2 3 4 5 6 7 8; do\n"
13076 " mknod -m 644 /dev/vcs$x c 7 $x;\n"
13077 " mknod -m 644 /dev/vcsa$x c 7 $[$x+128];\n"
13079 " chown root:tty /dev/vcs*\n"
13082 #. type: Plain text
13083 #: build/C/man4/vcs.4:81
13084 msgid "No B<ioctl>(2) requests are supported."
13087 #. type: Plain text
13088 #: build/C/man4/vcs.4:83
13089 msgid "/dev/vcs[0-63]"
13093 #. Andries Brouwer <aeb@cwi.nl>
13094 #. type: Plain text
13095 #: build/C/man4/vcs.4:87
13096 msgid "/dev/vcsa[0-63]"
13099 #. type: Plain text
13100 #: build/C/man4/vcs.4:89
13101 msgid "Introduced with version 1.1.92 of the Linux kernel."
13104 #. type: Plain text
13105 #: build/C/man4/vcs.4:96
13107 "You may do a screendump on vt3 by switching to vt1 and typing I<cat "
13108 "/dev/vcs3 E<gt>foo>. Note that the output does not contain newline "
13109 "characters, so some processing may be required, like in I<fold -w 81 "
13110 "/dev/vcs3 | lpr> or (horrors) I<setterm -dump 3 -file /proc/self/fd/1>."
13113 #. type: Plain text
13114 #: build/C/man4/vcs.4:98
13115 msgid "The I</dev/vcsa0> device is used for Braille support."
13118 #. type: Plain text
13119 #: build/C/man4/vcs.4:102
13121 "This program displays the character and screen attributes under the cursor "
13122 "of the second virtual console, then changes the background color there:"
13125 #. type: Plain text
13126 #: build/C/man4/vcs.4:110
13129 "#include E<lt>unistd.hE<gt>\n"
13130 "#include E<lt>stdlib.hE<gt>\n"
13131 "#include E<lt>stdio.hE<gt>\n"
13132 "#include E<lt>fcntl.hE<gt>\n"
13133 "#include E<lt>sys/ioctl.hE<gt>\n"
13134 "#include E<lt>linux/vt.hE<gt>\n"
13137 #. type: Plain text
13138 #: build/C/man4/vcs.4:121
13145 " char *device = \"/dev/vcsa2\";\n"
13146 " char *console = \"/dev/tty2\";\n"
13147 " struct {unsigned char lines, cols, x, y;} scrn;\n"
13148 " unsigned short s;\n"
13149 " unsigned short mask;\n"
13150 " unsigned char ch, attrib;\n"
13153 #. type: Plain text
13154 #: build/C/man4/vcs.4:150
13157 " fd = open(console, O_RDWR);\n"
13158 " if (fd E<lt> 0) {\n"
13159 " perror(console);\n"
13160 " exit(EXIT_FAILURE);\n"
13162 " if (ioctl(fd, VT_GETHIFONTMASK, &mask) E<lt> 0) {\n"
13163 " perror(\"VT_GETHIFONTMASK\");\n"
13164 " exit(EXIT_FAILURE);\n"
13166 " (void) close(fd);\n"
13167 " fd = open(device, O_RDWR);\n"
13168 " if (fd E<lt> 0) {\n"
13169 " perror(device);\n"
13170 " exit(EXIT_FAILURE);\n"
13172 " (void) read(fd, &scrn, 4);\n"
13173 " (void) lseek(fd, 4 + 2*(scrn.y*scrn.cols + scrn.x), 0);\n"
13174 " (void) read(fd, &s, 2);\n"
13175 " ch = s & 0xff;\n"
13176 " if (attrib & mask)\n"
13178 " attrib = ((s & ~mask) E<gt>E<gt> 8);\n"
13179 " printf(\"ch=\\(aq%c\\(aq attrib=0x%02x\\en\", ch, attrib);\n"
13180 " attrib ^= 0x10;\n"
13181 " (void) lseek(fd, -1, 1);\n"
13182 " (void) write(fd, &attrib, 1);\n"
13183 " exit(EXIT_SUCCESS);\n"
13187 #. type: Plain text
13188 #: build/C/man4/vcs.4:156
13189 msgid "B<console>(4), B<tty>(4), B<ttyS>(4), B<gpm>(8)"
13193 #: build/C/man4/wavelan.4:15
13199 #: build/C/man4/wavelan.4:15
13204 #. type: Plain text
13205 #: build/C/man4/wavelan.4:18
13206 msgid "wavelan - AT&T GIS WaveLAN ISA device driver"
13209 #. type: Plain text
13210 #: build/C/man4/wavelan.4:20
13212 "B<insmod wavelan_cs.o [io=>I<B,B..>B<] [ irq=>I<I,I..>B<] "
13213 "[name=>I<N,N..>B<]>"
13216 #. type: Plain text
13217 #: build/C/man4/wavelan.4:36
13219 "I<wavelan> is the low-level device driver for the NCR / AT&T / Lucent "
13220 "B<WaveLAN ISA> and Digital (DEC) B<RoamAbout DS> wireless ethernet "
13221 "adapter. This driver is available as a module or might be compiled in the "
13222 "kernel. This driver supports multiple cards in both forms (up to 4) and "
13223 "allocates the next available ethernet device (eth0..eth#) for each card "
13224 "found, unless a device name is explicitly specified (see below). This "
13225 "device name will be reported in the kernel log file with the MAC address, "
13226 "NWID and frequency used by the card."
13229 #. type: Plain text
13230 #: build/C/man4/wavelan.4:43
13232 "This section apply to the module form (parameters passed on the B<insmod>(8) "
13233 "command line). If the driver is included in the kernel, use the "
13234 "I<ether=IRQ,IO,NAME> syntax on the kernel command line."
13238 #: build/C/man4/wavelan.4:43
13243 #. type: Plain text
13244 #: build/C/man4/wavelan.4:50
13246 "Specify the list of base address where to search for wavelan cards (setting "
13247 "by dip switch on the card). If you don't specify any io address, the driver "
13248 "will scan 0x390 and 0x3E0 addresses, which might conflict with other "
13253 #: build/C/man4/wavelan.4:50
13258 #. type: Plain text
13259 #: build/C/man4/wavelan.4:54
13261 "Set the list of irq that each wavelan card should use (the value is saved in "
13262 "permanent storage for future use)."
13266 #: build/C/man4/wavelan.4:54
13271 #. type: Plain text
13272 #: build/C/man4/wavelan.4:59
13274 "Set the list of name to be used for each wavelan cards device (name used by "
13279 #: build/C/man4/wavelan.4:59
13281 msgid "Wireless extensions"
13284 #. type: Plain text
13285 #: build/C/man4/wavelan.4:63
13286 msgid "Use B<iwconfig>(8) to manipulate wireless extensions."
13290 #: build/C/man4/wavelan.4:63
13292 msgid "NWID (or domain)"
13295 #. type: Plain text
13296 #: build/C/man4/wavelan.4:72
13298 "Set the network ID [I<0> to I<FFFF>] or disable it [I<off>]. As the NWID is "
13299 "stored in the card Permanent Storage Area, it will be reuse at any further "
13300 "invocation of the driver."
13304 #: build/C/man4/wavelan.4:72
13306 msgid "Frequency & channels"
13309 #. type: Plain text
13310 #: build/C/man4/wavelan.4:83
13312 "For the 2.4GHz 2.00 Hardware, you are able to set the frequency by "
13313 "specifying one of the 10 defined channels (I<2.412,> I<2.422, 2.425, 2.4305, "
13314 "2.432, 2.442, 2.452, 2.460, 2.462> or I<2.484>) or directly by its value. "
13315 "The frequency is changed immediately and permanently. Frequency "
13316 "availability depends on the regulations..."
13320 #: build/C/man4/wavelan.4:83
13322 msgid "Statistics spy"
13325 #. type: Plain text
13326 #: build/C/man4/wavelan.4:87
13328 "Set a list of MAC addresses in the driver (up to 8) and get the last quality "
13329 "of link for each of those (see B<iwspy>(8))."
13333 #: build/C/man4/wavelan.4:87
13335 msgid "/proc/net/wireless"
13338 #. type: Plain text
13339 #: build/C/man4/wavelan.4:102
13341 "I<status> is the status reported by the modem. I<Link quality> reports the "
13342 "quality of the modulation on the air (direct sequence spread spectrum) [max "
13343 "= 16]. I<Level> and I<Noise> refer to the signal level and noise level [max "
13344 "= 64]. The I<crypt discarded packet> and I<misc discarded packet> counters "
13345 "are not implemented."
13349 #: build/C/man4/wavelan.4:102
13351 msgid "Private ioctl"
13354 #. type: Plain text
13355 #: build/C/man4/wavelan.4:106
13356 msgid "You may use B<iwpriv>(8) to manipulate private ioctls."
13360 #: build/C/man4/wavelan.4:106
13362 msgid "Quality and level threshold"
13365 #. type: Plain text
13366 #: build/C/man4/wavelan.4:109
13368 "Enable you the define the quality and level threshold used by the modem "
13369 "(packet below that level are discarded)."
13373 #: build/C/man4/wavelan.4:109
13378 #. type: Plain text
13379 #: build/C/man4/wavelan.4:116
13381 "This functionality makes it possible to set a number of signal level "
13382 "intervals and to count the number of packets received in each of those "
13383 "defined intervals. This distribution might be used to calculate the mean "
13384 "value and standard deviation of the signal level."
13388 #: build/C/man4/wavelan.4:116
13390 msgid "Specific notes"
13393 #. type: Plain text
13394 #: build/C/man4/wavelan.4:122
13396 "This driver will fail to detect some B<non-NCR/ATT&T/Lucent> Wavelan cards. "
13397 "If this happens for you, you must look in the source code on how to add your "
13398 "card to the detection routine."
13402 #. Bruce Janson \(em bruce@cs.usyd.edu.au
13404 #. Jean Tourrilhes \(em jt@hplb.hpl.hp.com
13406 #. (and others; see source code for details)
13409 #. type: Plain text
13410 #: build/C/man4/wavelan.4:135
13412 "Some of the mentioned features are optional. You may enable to disable them "
13413 "by changing flags in the driver header and recompile."
13416 #. type: Plain text
13417 #: build/C/man4/wavelan.4:142
13419 "B<wavelan_cs>(4), B<ifconfig>(8), B<insmod>(8), B<iwconfig>(8), "
13420 "B<iwpriv>(8), B<iwspy>(8)"