source: BOOK/final-system/common/util-linux-ng.xml@ f6adffe

clfs-1.2 clfs-2.1 clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since f6adffe was 17e4e83, checked in by Chris Staub <chris@…>, 17 years ago

Add command explanations for util-linux-ng configure

  • Property mode set to 100644
File size: 23.6 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6]>
7
8<sect1 id="ch-system-util-linux-ng" role="wrap">
9 <?dbhtml filename="util-linux-ng.html"?>
10
11 <title>Util-linux-ng-&util-linux-ng-version;</title>
12
13 <indexterm zone="ch-system-util-linux-ng">
14 <primary sortas="a-Util-linux-ng">Util-linux-ng</primary>
15 </indexterm>
16
17 <sect2 role="package">
18 <title/>
19
20 <para>The Util-linux-ng package contains miscellaneous utility programs.
21 Among them are utilities for handling file systems, consoles, partitions,
22 and messages.</para>
23
24
25 </sect2>
26
27 <sect2 id="fhs-util-linux-ng" role="installation">
28 <title>FHS compliance notes</title>
29
30 <para>The FHS recommends using the <filename
31 class="directory">/var/lib/hwclock</filename> directory instead of the
32 usual <filename class="directory">/etc</filename> directory as the
33 location for the <filename>adjtime</filename> file. To make the
34 <command>hwclock</command> program FHS-compliant, run the following:</para>
35
36<screen><userinput>sed -i 's@etc/adjtime@var/lib/hwclock/adjtime@g' \
37 hwclock/hwclock.c
38mkdir -pv /var/lib/hwclock</userinput></screen>
39
40 </sect2>
41
42 <sect2 role="installation">
43 <title>Installation of Util-linux-ng</title>
44
45 <para os="a">Prepare Util-linux-ng for compilation:</para>
46
47<screen os="b"><userinput>./configure --enable-partx --disable-wall --enable-write</userinput></screen>
48
49 <variablelist os="c">
50 <title>The meaning of the configure options:</title>
51
52 <varlistentry>
53 <term><parameter>--enable-partx</parameter></term>
54 <listitem>
55 <para>Enable partx stuff (need more description).</para>
56 </listitem>
57 </varlistentry>
58
59 <varlistentry>
60 <term><parameter>--disable-wall</parameter></term>
61 <listitem>
62 <para>Disables building the <command>wall</command> program,
63 as the Sysvinit package installs its own version.</para>
64 </listitem>
65 </varlistentry>
66
67 <varlistentry>
68 <term><parameter>--enable-write</parameter></term>
69 <listitem>
70 <para>This option allows the <command>write</command> program to be
71 installed.</para>
72 </listitem>
73 </varlistentry>
74
75 </variablelist>
76
77 <para os="d">Compile the package:</para>
78
79<screen os="e"><userinput>make</userinput></screen>
80
81 <para os="f">This package does not come with a test suite.</para>
82
83 <para os="g">Install the package:</para>
84
85<screen os="h"><userinput>make install</userinput></screen>
86
87 <para os="i">Move the <command>logger</command> binary to
88 <filename class="directory">/bin</filename> as it is needed by the
89 CLFS-Bootscripts package:</para>
90
91<screen os="j"><userinput>mv -v /usr/bin/logger /bin</userinput></screen>
92
93 </sect2>
94
95 <sect2 id="contents-util-linux-ng" role="content">
96 <title>Contents of Util-linux-ng</title>
97
98 <segmentedlist>
99 <segtitle>Installed programs</segtitle>
100
101 <seglistitem>
102 <seg>agetty, blockdev, cal, cfdisk, chkdupexe, col, colcrt,
103 colrm, column, ctrlaltdel, cytune, ddate, dmesg, fdformat,
104 fdisk, flock, fsck.cramfs, fsck.minix, getopt, hexdump, hwclock, ipcrm,
105 ipcs, isosize, line, logger, look, losetup, mcookie, mkfs, mkfs.bfs,
106 mkfs.cramfs, mkfs.minix, mkswap, more, mount, namei, pg, pivot_root,
107 readprofile, rename, renice, rev, script, setsid, setterm, sfdisk,
108 swapoff (link to swapon), swapon, tailf, tunelp, ul, umount, whereis, and write</seg>
109 </seglistitem>
110 </segmentedlist>
111
112 <variablelist>
113 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
114 <?dbfo list-presentation="list"?>
115 <?dbhtml list-presentation="table"?>
116
117 <varlistentry id="agetty">
118 <term><command>agetty</command></term>
119 <listitem>
120 <para>Opens a tty port, prompts for a login name,
121 and then invokes the <command>login</command> program</para>
122 <indexterm zone="ch-system-util-linux-ng agetty">
123 <primary sortas="b-agetty">agetty</primary>
124 </indexterm>
125 </listitem>
126 </varlistentry>
127
128 <varlistentry id="blockdev">
129 <term><command>blockdev</command></term>
130 <listitem>
131 <para>Allows users to call block device ioctls from the command
132 line</para>
133 <indexterm zone="ch-system-util-linux-ng blockdev">
134 <primary sortas="b-blockdev">blockdev</primary>
135 </indexterm>
136 </listitem>
137 </varlistentry>
138
139 <varlistentry id="cal">
140 <term><command>cal</command></term>
141 <listitem>
142 <para>Displays a simple calendar</para>
143 <indexterm zone="ch-system-util-linux-ng cal">
144 <primary sortas="b-cal">cal</primary>
145 </indexterm>
146 </listitem>
147 </varlistentry>
148
149 <varlistentry id="cfdisk">
150 <term><command>cfdisk</command></term>
151 <listitem>
152 <para>Manipulates the partition table of the given device</para>
153 <indexterm zone="ch-system-util-linux-ng cfdisk">
154 <primary sortas="b-cfdisk">cfdisk</primary>
155 </indexterm>
156 </listitem>
157 </varlistentry>
158
159 <varlistentry id="chkdupexe">
160 <term><command>chkdupexe</command></term>
161 <listitem>
162 <para>Finds duplicate executables</para>
163 <indexterm zone="ch-system-util-linux-ng chkdupexe">
164 <primary sortas="b-chkdupexe">chkdupexe</primary>
165 </indexterm>
166 </listitem>
167 </varlistentry>
168
169 <varlistentry id="col">
170 <term><command>col</command></term>
171 <listitem>
172 <para>Filters out reverse line feeds</para>
173 <indexterm zone="ch-system-util-linux-ng col">
174 <primary sortas="b-col">col</primary>
175 </indexterm>
176 </listitem>
177 </varlistentry>
178
179 <varlistentry id="colcrt">
180 <term><command>colcrt</command></term>
181 <listitem>
182 <para>Filters <command>nroff</command> output for terminals
183 that lack some capabilities, such as overstriking and half-lines</para>
184 <indexterm zone="ch-system-util-linux-ng colcrt">
185 <primary sortas="b-colcrt">colcrt</primary>
186 </indexterm>
187 </listitem>
188 </varlistentry>
189
190 <varlistentry id="colrm">
191 <term><command>colrm</command></term>
192 <listitem>
193 <para>Filters out the given columns</para>
194 <indexterm zone="ch-system-util-linux-ng colrm">
195 <primary sortas="b-colrm">colrm</primary>
196 </indexterm>
197 </listitem>
198 </varlistentry>
199
200 <varlistentry id="column">
201 <term><command>column</command></term>
202 <listitem>
203 <para>Formats a given file into multiple columns</para>
204 <indexterm zone="ch-system-util-linux-ng column">
205 <primary sortas="b-column">column</primary>
206 </indexterm>
207 </listitem>
208 </varlistentry>
209
210 <varlistentry id="ctrlaltdel">
211 <term><command>ctrlaltdel</command></term>
212 <listitem>
213 <para>Sets the function of the Ctrl+Alt+Del key combination to a
214 hard or a soft reset</para>
215 <indexterm zone="ch-system-util-linux-ng ctrlaltdel">
216 <primary sortas="b-ctrlaltdel">ctrlaltdel</primary>
217 </indexterm>
218 </listitem>
219 </varlistentry>
220
221 <varlistentry id="cytune">
222 <term><command>cytune</command></term>
223 <listitem>
224 <para>Tunes the parameters of the serial line drivers for
225 Cyclades cards</para>
226 <indexterm zone="ch-system-util-linux-ng cytune">
227 <primary sortas="b-cytune">cytune</primary>
228 </indexterm>
229 </listitem>
230 </varlistentry>
231
232 <varlistentry id="ddate">
233 <term><command>ddate</command></term>
234 <listitem>
235 <para>Gives the Discordian date or converts the given Gregorian date
236 to a Discordian one</para>
237 <indexterm zone="ch-system-util-linux-ng ddate">
238 <primary sortas="b-ddate">ddate</primary>
239 </indexterm>
240 </listitem>
241 </varlistentry>
242
243 <varlistentry id="dmesg">
244 <term><command>dmesg</command></term>
245 <listitem>
246 <para>Dumps the kernel boot messages</para>
247 <indexterm zone="ch-system-util-linux-ng dmesg">
248 <primary sortas="b-dmesg">dmesg</primary>
249 </indexterm>
250 </listitem>
251 </varlistentry>
252
253 <varlistentry id="fdformat">
254 <term><command>fdformat</command></term>
255 <listitem>
256 <para>Low-level formats a floppy disk</para>
257 <indexterm zone="ch-system-util-linux-ng fdformat">
258 <primary sortas="b-fdformat">fdformat</primary>
259 </indexterm>
260 </listitem>
261 </varlistentry>
262
263 <varlistentry id="fdisk">
264 <term><command>fdisk</command></term>
265 <listitem>
266 <para>Manipulates the partition table of the given device</para>
267 <indexterm zone="ch-system-util-linux-ng fdisk">
268 <primary sortas="b-fdisk">fdisk</primary>
269 </indexterm>
270 </listitem>
271 </varlistentry>
272
273 <varlistentry id="flock">
274 <term><command>flock</command></term>
275 <listitem>
276 <para>Acquires a file lock and then executes a command with the lock
277 held</para>
278 <indexterm zone="ch-system-util-linux-ng flock">
279 <primary sortas="b-flock">flock</primary>
280 </indexterm>
281 </listitem>
282 </varlistentry>
283
284 <varlistentry id="fsck.cramfs">
285 <term><command>fsck.cramfs</command></term>
286 <listitem>
287 <para>Performs a consistency check on the Cramfs file system on the
288 given device</para>
289 <indexterm zone="ch-system-util-linux-ng fsck.cramfs">
290 <primary sortas="b-fsck.cramfs">fsck.cramfs</primary>
291 </indexterm>
292 </listitem>
293 </varlistentry>
294
295 <varlistentry id="fsck.minix">
296 <term><command>fsck.minix</command></term>
297 <listitem>
298 <para>Performs a consistency check on the Minix file system on the
299 given device</para>
300 <indexterm zone="ch-system-util-linux-ng fsck.minix">
301 <primary sortas="b-fsck.minix">fsck.minix</primary>
302 </indexterm>
303 </listitem>
304 </varlistentry>
305
306 <varlistentry id="getopt">
307 <term><command>getopt</command></term>
308 <listitem>
309 <para>Parses options in the given command line</para>
310 <indexterm zone="ch-system-util-linux-ng getopt">
311 <primary sortas="b-getopt">getopt</primary>
312 </indexterm>
313 </listitem>
314 </varlistentry>
315
316 <varlistentry id="hexdump">
317 <term><command>hexdump</command></term>
318 <listitem>
319 <para>Dumps the given file in hexadecimal or in another given
320 format</para>
321 <indexterm zone="ch-system-util-linux-ng hexdump">
322 <primary sortas="b-hexdump">hexdump</primary>
323 </indexterm>
324 </listitem>
325 </varlistentry>
326
327 <varlistentry id="hwclock">
328 <term><command>hwclock</command></term>
329 <listitem>
330 <para>Reads or sets the system's hardware clock, also called
331 the Real-Time Clock (RTC) or Basic Input-Output System (BIOS)
332 clock</para>
333 <indexterm zone="ch-system-util-linux-ng hwclock">
334 <primary sortas="b-hwclock">hwclock</primary>
335 </indexterm>
336 </listitem>
337 </varlistentry>
338
339 <varlistentry id="ipcrm">
340 <term><command>ipcrm</command></term>
341 <listitem>
342 <para>Removes the given Inter-Process Communication (IPC) resource</para>
343 <indexterm zone="ch-system-util-linux-ng ipcrm">
344 <primary sortas="b-ipcrm">ipcrm</primary>
345 </indexterm>
346 </listitem>
347 </varlistentry>
348
349 <varlistentry id="ipcs">
350 <term><command>ipcs</command></term>
351 <listitem>
352 <para>Provides IPC status information</para>
353 <indexterm zone="ch-system-util-linux-ng ipcs">
354 <primary sortas="b-ipcs">ipcs</primary>
355 </indexterm>
356 </listitem>
357 </varlistentry>
358
359 <varlistentry id="isosize">
360 <term><command>isosize</command></term>
361 <listitem>
362 <para>Reports the size of an iso9660 file system</para>
363 <indexterm zone="ch-system-util-linux-ng isosize">
364 <primary sortas="b-isosize">isosize</primary>
365 </indexterm>
366 </listitem>
367 </varlistentry>
368
369 <varlistentry id="line">
370 <term><command>line</command></term>
371 <listitem>
372 <para>Copies a single line</para>
373 <indexterm zone="ch-system-util-linux-ng line">
374 <primary sortas="b-line">line</primary>
375 </indexterm>
376 </listitem>
377 </varlistentry>
378
379 <varlistentry id="logger">
380 <term><command>logger</command></term>
381 <listitem>
382 <para>Enters the given message into the system log</para>
383 <indexterm zone="ch-system-util-linux-ng logger">
384 <primary sortas="b-logger">logger</primary>
385 </indexterm>
386 </listitem>
387 </varlistentry>
388
389 <varlistentry id="look">
390 <term><command>look</command></term>
391 <listitem>
392 <para>Displays lines that begin with the given string</para>
393 <indexterm zone="ch-system-util-linux-ng look">
394 <primary sortas="b-look">look</primary>
395 </indexterm>
396 </listitem>
397 </varlistentry>
398
399 <varlistentry id="losetup">
400 <term><command>losetup</command></term>
401 <listitem>
402 <para>Sets up and controls loop devices</para>
403 <indexterm zone="ch-system-util-linux-ng losetup">
404 <primary sortas="b-losetup">losetup</primary>
405 </indexterm>
406 </listitem>
407 </varlistentry>
408
409 <varlistentry id="mcookie">
410 <term><command>mcookie</command></term>
411 <listitem>
412 <para>Generates magic cookies (128-bit random hexadecimal numbers) for
413 <command>xauth</command></para>
414 <indexterm zone="ch-system-util-linux-ng mcookie">
415 <primary sortas="b-mcookie">mcookie</primary>
416 </indexterm>
417 </listitem>
418 </varlistentry>
419
420 <varlistentry id="mkfs">
421 <term><command>mkfs</command></term>
422 <listitem>
423 <para>Builds a file system on a device (usually a hard disk
424 partition)</para>
425 <indexterm zone="ch-system-util-linux-ng mkfs">
426 <primary sortas="b-mkfs">mkfs</primary>
427 </indexterm>
428 </listitem>
429 </varlistentry>
430
431 <varlistentry id="mkfs.bfs">
432 <term><command>mkfs.bfs</command></term>
433 <listitem>
434 <para>Creates a Santa Cruz Operations (SCO) bfs file system</para>
435 <indexterm zone="ch-system-util-linux-ng mkfs.bfs">
436 <primary sortas="b-mkfs.bfs">mkfs.bfs</primary>
437 </indexterm>
438 </listitem>
439 </varlistentry>
440
441 <varlistentry id="mkfs.cramfs">
442 <term><command>mkfs.cramfs</command></term>
443 <listitem>
444 <para>Creates a cramfs file system</para>
445 <indexterm zone="ch-system-util-linux-ng mkfs.cramfs">
446 <primary sortas="b-mkfs.cramfs">mkfs.cramfs</primary>
447 </indexterm>
448 </listitem>
449 </varlistentry>
450
451 <varlistentry id="mkfs.minix">
452 <term><command>mkfs.minix</command></term>
453 <listitem>
454 <para>Creates a Minix file system</para>
455 <indexterm zone="ch-system-util-linux-ng mkfs.minix">
456 <primary sortas="b-mkfs.minix">mkfs.minix</primary>
457 </indexterm>
458 </listitem>
459 </varlistentry>
460
461 <varlistentry id="mkswap">
462 <term><command>mkswap</command></term>
463 <listitem>
464 <para>Initializes the given device or file to be used as a swap
465 area</para>
466 <indexterm zone="ch-system-util-linux-ng mkswap">
467 <primary sortas="b-mkswap">mkswap</primary>
468 </indexterm>
469 </listitem>
470 </varlistentry>
471
472 <varlistentry id="more">
473 <term><command>more</command></term>
474 <listitem>
475 <para>A filter for paging through text one screen at a time</para>
476 <indexterm zone="ch-system-util-linux-ng more">
477 <primary sortas="b-more">more</primary>
478 </indexterm>
479 </listitem>
480 </varlistentry>
481
482 <varlistentry id="mount">
483 <term><command>mount</command></term>
484 <listitem>
485 <para>Attaches the file system on the given device to a specified
486 directory in the file-system tree</para>
487 <indexterm zone="ch-system-util-linux-ng mount">
488 <primary sortas="b-mount">mount</primary>
489 </indexterm>
490 </listitem>
491 </varlistentry>
492
493 <varlistentry id="namei">
494 <term><command>namei</command></term>
495 <listitem>
496 <para>Shows the symbolic links in the given pathnames</para>
497 <indexterm zone="ch-system-util-linux-ng namei">
498 <primary sortas="b-namei">namei</primary>
499 </indexterm>
500 </listitem>
501 </varlistentry>
502
503 <varlistentry id="pg">
504 <term><command>pg</command></term>
505 <listitem>
506 <para>Displays a text file one screen full at a time</para>
507 <indexterm zone="ch-system-util-linux-ng pg">
508 <primary sortas="b-pg">pg</primary>
509 </indexterm>
510 </listitem>
511 </varlistentry>
512
513 <varlistentry id="pivot_root">
514 <term><command>pivot_root</command></term>
515 <listitem>
516 <para>Makes the given file system the new root file system of the
517 current process</para>
518 <indexterm zone="ch-system-util-linux-ng pivot_root">
519 <primary sortas="b-pivot_root">pivot_root</primary>
520 </indexterm>
521 </listitem>
522 </varlistentry>
523
524 <varlistentry id="readprofile">
525 <term><command>readprofile</command></term>
526 <listitem>
527 <para>Reads kernel profiling information</para>
528 <indexterm zone="ch-system-util-linux-ng readprofile">
529 <primary sortas="b-readprofile">readprofile</primary>
530 </indexterm>
531 </listitem>
532 </varlistentry>
533
534 <varlistentry id="rename">
535 <term><command>rename</command></term>
536 <listitem>
537 <para>Renames the given files, replacing a given string with
538 another</para>
539 <indexterm zone="ch-system-util-linux-ng rename">
540 <primary sortas="b-rename">rename</primary>
541 </indexterm>
542 </listitem>
543 </varlistentry>
544
545 <varlistentry id="renice">
546 <term><command>renice</command></term>
547 <listitem>
548 <para>Alters the priority of running processes</para>
549 <indexterm zone="ch-system-util-linux-ng renice">
550 <primary sortas="b-renice">renice</primary>
551 </indexterm>
552 </listitem>
553 </varlistentry>
554
555 <varlistentry id="rev">
556 <term><command>rev</command></term>
557 <listitem>
558 <para>Reverses the lines of a given file</para>
559 <indexterm zone="ch-system-util-linux-ng rev">
560 <primary sortas="b-rev">rev</primary>
561 </indexterm>
562 </listitem>
563 </varlistentry>
564
565 <varlistentry id="script">
566 <term><command>script</command></term>
567 <listitem>
568 <para>Makes a typescript of a terminal session</para>
569 <indexterm zone="ch-system-util-linux-ng script">
570 <primary sortas="b-script">script</primary>
571 </indexterm>
572 </listitem>
573 </varlistentry>
574
575 <varlistentry id="setsid">
576 <term><command>setsid</command></term>
577 <listitem>
578 <para>Runs the given program in a new session</para>
579 <indexterm zone="ch-system-util-linux-ng setsid">
580 <primary sortas="b-setsid">setsid</primary>
581 </indexterm>
582 </listitem>
583 </varlistentry>
584
585 <varlistentry id="setterm">
586 <term><command>setterm</command></term>
587 <listitem>
588 <para>Sets terminal attributes</para>
589 <indexterm zone="ch-system-util-linux-ng setterm">
590 <primary sortas="b-setterm">setterm</primary>
591 </indexterm>
592 </listitem>
593 </varlistentry>
594
595 <varlistentry id="sfdisk">
596 <term><command>sfdisk</command></term>
597 <listitem>
598 <para>A disk partition table manipulator</para>
599 <indexterm zone="ch-system-util-linux-ng sfdisk">
600 <primary sortas="b-sfdisk">sfdisk</primary>
601 </indexterm>
602 </listitem>
603 </varlistentry>
604
605 <varlistentry id="swapoff">
606 <term><command>swapoff</command></term>
607 <listitem>
608 <para>Disables devices and files for paging and swapping</para>
609 <indexterm zone="ch-system-util-linux-ng swapoff">
610 <primary sortas="b-swapoff">swapoff</primary>
611 </indexterm>
612 </listitem>
613 </varlistentry>
614
615 <varlistentry id="swapon">
616 <term><command>swapon</command></term>
617 <listitem>
618 <para>Enables devices and files for paging and swapping and
619 lists the devices and files currently in use</para>
620 <indexterm zone="ch-system-util-linux-ng swapon">
621 <primary sortas="b-swapon">swapon</primary>
622 </indexterm>
623 </listitem>
624 </varlistentry>
625
626 <varlistentry id="tailf">
627 <term><command>tailf</command></term>
628 <listitem>
629 <para>Tracks the growth of a log file. Displays the last 10 lines
630 of a log file, then continues displaying any new entries in the
631 log file as they are created</para>
632 <indexterm zone="ch-system-util-linux-ng tailf">
633 <primary sortas="b-tailf">tailf</primary>
634 </indexterm>
635 </listitem>
636 </varlistentry>
637
638 <varlistentry id="tunelp">
639 <term><command>tunelp</command></term>
640 <listitem>
641 <para>Tunes the parameters of the line printer</para>
642 <indexterm zone="ch-system-util-linux-ng tunelp">
643 <primary sortas="b-tunelp">tunelp</primary>
644 </indexterm>
645 </listitem>
646 </varlistentry>
647
648 <varlistentry id="ul">
649 <term><command>ul</command></term>
650 <listitem>
651 <para>A filter for translating underscores into escape sequences
652 indicating underlining for the terminal in use</para>
653 <indexterm zone="ch-system-util-linux-ng ul">
654 <primary sortas="b-ul">ul</primary>
655 </indexterm>
656 </listitem>
657 </varlistentry>
658
659 <varlistentry id="umount">
660 <term><command>umount</command></term>
661 <listitem>
662 <para>Disconnects a file system from the system's file tree</para>
663 <indexterm zone="ch-system-util-linux-ng umount">
664 <primary sortas="b-umount">umount</primary>
665 </indexterm>
666 </listitem>
667 </varlistentry>
668
669 <varlistentry id="whereis">
670 <term><command>whereis</command></term>
671 <listitem>
672 <para>Reports the location of the binary, source, and man page
673 for the given command</para>
674 <indexterm zone="ch-system-util-linux-ng whereis">
675 <primary sortas="b-whereis">whereis</primary>
676 </indexterm>
677 </listitem>
678 </varlistentry>
679
680 <varlistentry id="write">
681 <term><command>write</command></term>
682 <listitem>
683 <para>Sends a message to the given user <emphasis>if</emphasis> that
684 user has not disabled receipt of such messages</para>
685 <indexterm zone="ch-system-util-linux-ng write">
686 <primary sortas="b-write">write</primary>
687 </indexterm>
688 </listitem>
689 </varlistentry>
690
691 </variablelist>
692
693 </sect2>
694
695</sect1>
Note: See TracBrowser for help on using the repository browser.