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

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;
]>

<sect1 id="ch-system-util-linux-ng" role="wrap">
  <?dbhtml filename="util-linux-ng.html"?>

  <title>Util-linux-ng-&util-linux-ng-version;</title>

  <indexterm zone="ch-system-util-linux-ng">
    <primary sortas="a-Util-linux-ng">Util-linux-ng</primary>
  </indexterm>

  <sect2 role="package">
    <title/>

    <para>The Util-linux-ng package contains miscellaneous utility programs.
    Among them are utilities for handling file systems, consoles, partitions,
    and messages.</para>


  </sect2>

  <sect2 id="fhs-util-linux-ng" role="installation">
    <title>FHS compliance notes</title>

    <para>The FHS recommends using the <filename
    class="directory">/var/lib/hwclock</filename> directory instead of the
    usual <filename class="directory">/etc</filename> directory as the
    location for the <filename>adjtime</filename> file. To make the
    <command>hwclock</command> program FHS-compliant, run the following:</para>

<screen><userinput>sed -i 's@etc/adjtime@var/lib/hwclock/adjtime@g' \
    hwclock/hwclock.c
mkdir -pv /var/lib/hwclock</userinput></screen>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Util-linux-ng</title>

    <para os="a">Prepare Util-linux-ng for compilation:</para>

<screen os="b"><userinput>CC="gcc ${BUILD32}" ./configure --with-fsprobe=blkid --enable-agetty \
    --enable-cramfs --disable-init --disable-kill --disable-last \
    --disable-mesg --enable-partx --enable-rename --disable-reset \
    --disable-login-utils --enable-schedutils --disable-wall --enable-write \
    --without-pam</userinput></screen>

    <para os="c">Compile the package:</para>

<screen os="d"><userinput>make</userinput></screen>

    <para os="e">This package does not come with a test suite.</para>

    <para os="g">Install the package:</para>

<screen os="h"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 id="contents-util-linux-ng" role="content">
    <title>Contents of Util-linux-ng</title>

    <segmentedlist>
      <segtitle>Installed programs</segtitle>

      <seglistitem>
        <seg>agetty, arch, blockdev, cal, cfdisk, chkdupexe, col, colcrt,
        colrm, column, ctrlaltdel, cytune, ddate, dmesg, elvtune, fdformat,
        fdisk, flock, fsck.cramfs, fsck.minix, getopt, hexdump, hwclock, ipcrm,
        ipcs, isosize, line, logger, look, losetup, mcookie, mkfs, mkfs.bfs,
        mkfs.cramfs, mkfs.minix, mkswap, more, mount, namei, pg, pivot_root,
        ramsize (link to rdev), raw, rdev, readprofile, rename, renice, rev,
        rootflags (link to rdev), script, setfdprm, setsid, setterm, sfdisk,
        swapoff (link to swapon), swapon, tailf, tunelp, ul, umount, vidmode
        (link to rdev), whereis, and write</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="agetty">
        <term><command>agetty</command></term>
        <listitem>
          <para>Opens a tty port, prompts for a login name,
          and then invokes the <command>login</command> program</para>
          <indexterm zone="ch-system-util-linux-ng agetty">
            <primary sortas="b-agetty">agetty</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="arch">
        <term><command>arch</command></term>
        <listitem>
          <para>Reports the machine's architecture</para>
          <indexterm zone="ch-system-util-linux-ng arch">
            <primary sortas="b-arch">arch</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="blockdev">
        <term><command>blockdev</command></term>
        <listitem>
          <para>Allows users to call block device ioctls from the command
          line</para>
          <indexterm zone="ch-system-util-linux-ng blockdev">
            <primary sortas="b-blockdev">blockdev</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="cal">
        <term><command>cal</command></term>
        <listitem>
          <para>Displays a simple calendar</para>
          <indexterm zone="ch-system-util-linux-ng cal">
            <primary sortas="b-cal">cal</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="cfdisk">
        <term><command>cfdisk</command></term>
        <listitem>
          <para>Manipulates the partition table of the given device</para>
          <indexterm zone="ch-system-util-linux-ng cfdisk">
            <primary sortas="b-cfdisk">cfdisk</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="chkdupexe">
        <term><command>chkdupexe</command></term>
        <listitem>
          <para>Finds duplicate executables</para>
          <indexterm zone="ch-system-util-linux-ng chkdupexe">
            <primary sortas="b-chkdupexe">chkdupexe</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="col">
        <term><command>col</command></term>
        <listitem>
          <para>Filters out reverse line feeds</para>
          <indexterm zone="ch-system-util-linux-ng col">
            <primary sortas="b-col">col</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="colcrt">
        <term><command>colcrt</command></term>
        <listitem>
          <para>Filters <command>nroff</command> output for terminals
          that lack some capabilities, such as overstriking and half-lines</para>
          <indexterm zone="ch-system-util-linux-ng colcrt">
            <primary sortas="b-colcrt">colcrt</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="colrm">
        <term><command>colrm</command></term>
        <listitem>
          <para>Filters out the given columns</para>
          <indexterm zone="ch-system-util-linux-ng colrm">
            <primary sortas="b-colrm">colrm</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="column">
        <term><command>column</command></term>
        <listitem>
          <para>Formats a given file into multiple columns</para>
          <indexterm zone="ch-system-util-linux-ng column">
            <primary sortas="b-column">column</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ctrlaltdel">
        <term><command>ctrlaltdel</command></term>
        <listitem>
          <para>Sets the function of the Ctrl+Alt+Del key combination to a
          hard or a soft reset</para>
          <indexterm zone="ch-system-util-linux-ng ctrlaltdel">
            <primary sortas="b-ctrlaltdel">ctrlaltdel</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="cytune">
        <term><command>cytune</command></term>
        <listitem>
          <para>Tunes the parameters of the serial line drivers for
          Cyclades cards</para>
          <indexterm zone="ch-system-util-linux-ng cytune">
            <primary sortas="b-cytune">cytune</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ddate">
        <term><command>ddate</command></term>
        <listitem>
          <para>Gives the Discordian date or converts the given Gregorian date
          to a Discordian one</para>
          <indexterm zone="ch-system-util-linux-ng ddate">
            <primary sortas="b-ddate">ddate</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="dmesg">
        <term><command>dmesg</command></term>
        <listitem>
          <para>Dumps the kernel boot messages</para>
          <indexterm zone="ch-system-util-linux-ng dmesg">
            <primary sortas="b-dmesg">dmesg</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="elvtune">
        <term><command>elvtune</command></term>
        <listitem>
          <para>Tunes the performance and interactivity of a block
          device</para>
          <indexterm zone="ch-system-util-linux-ng elvtune">
            <primary sortas="b-elvtune">elvtune</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="fdformat">
        <term><command>fdformat</command></term>
        <listitem>
          <para>Low-level formats a floppy disk</para>
          <indexterm zone="ch-system-util-linux-ng fdformat">
            <primary sortas="b-fdformat">fdformat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="fdisk">
        <term><command>fdisk</command></term>
        <listitem>
          <para>Manipulates the partition table of the given device</para>
          <indexterm zone="ch-system-util-linux-ng fdisk">
            <primary sortas="b-fdisk">fdisk</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="flock">
        <term><command>flock</command></term>
        <listitem>
          <para>Acquires a file lock and then executes a command with the lock
          held</para>
          <indexterm zone="ch-system-util-linux-ng flock">
            <primary sortas="b-flock">flock</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="fsck.cramfs">
        <term><command>fsck.cramfs</command></term>
        <listitem>
          <para>Performs a consistency check on the Cramfs file system on the
          given device</para>
          <indexterm zone="ch-system-util-linux-ng fsck.cramfs">
            <primary sortas="b-fsck.cramfs">fsck.cramfs</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="fsck.minix">
        <term><command>fsck.minix</command></term>
        <listitem>
          <para>Performs a consistency check on the Minix file system on the
          given device</para>
          <indexterm zone="ch-system-util-linux-ng fsck.minix">
            <primary sortas="b-fsck.minix">fsck.minix</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="getopt">
        <term><command>getopt</command></term>
        <listitem>
          <para>Parses options in the given command line</para>
          <indexterm zone="ch-system-util-linux-ng getopt">
            <primary sortas="b-getopt">getopt</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="hexdump">
        <term><command>hexdump</command></term>
        <listitem>
          <para>Dumps the given file in hexadecimal or in another given
          format</para>
          <indexterm zone="ch-system-util-linux-ng hexdump">
            <primary sortas="b-hexdump">hexdump</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="hwclock">
        <term><command>hwclock</command></term>
        <listitem>
          <para>Reads or sets the system's hardware clock, also called
          the Real-Time Clock (RTC) or Basic Input-Output System (BIOS)
          clock</para>
          <indexterm zone="ch-system-util-linux-ng hwclock">
            <primary sortas="b-hwclock">hwclock</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ipcrm">
        <term><command>ipcrm</command></term>
        <listitem>
          <para>Removes the given Inter-Process Communication (IPC) resource</para>
          <indexterm zone="ch-system-util-linux-ng ipcrm">
            <primary sortas="b-ipcrm">ipcrm</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ipcs">
        <term><command>ipcs</command></term>
        <listitem>
          <para>Provides IPC status information</para>
          <indexterm zone="ch-system-util-linux-ng ipcs">
            <primary sortas="b-ipcs">ipcs</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="isosize">
        <term><command>isosize</command></term>
        <listitem>
          <para>Reports the size of an iso9660 file system</para>
          <indexterm zone="ch-system-util-linux-ng isosize">
            <primary sortas="b-isosize">isosize</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="line">
        <term><command>line</command></term>
        <listitem>
          <para>Copies a single line</para>
          <indexterm zone="ch-system-util-linux-ng line">
            <primary sortas="b-line">line</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="logger">
        <term><command>logger</command></term>
        <listitem>
          <para>Enters the given message into the system log</para>
          <indexterm zone="ch-system-util-linux-ng logger">
            <primary sortas="b-logger">logger</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="look">
        <term><command>look</command></term>
        <listitem>
          <para>Displays lines that begin with the given string</para>
          <indexterm zone="ch-system-util-linux-ng look">
            <primary sortas="b-look">look</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="losetup">
        <term><command>losetup</command></term>
        <listitem>
          <para>Sets up and controls loop devices</para>
          <indexterm zone="ch-system-util-linux-ng losetup">
            <primary sortas="b-losetup">losetup</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mcookie">
        <term><command>mcookie</command></term>
        <listitem>
          <para>Generates magic cookies (128-bit random hexadecimal numbers) for
          <command>xauth</command></para>
          <indexterm zone="ch-system-util-linux-ng mcookie">
            <primary sortas="b-mcookie">mcookie</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mkfs">
        <term><command>mkfs</command></term>
        <listitem>
          <para>Builds a file system on a device (usually a hard disk
          partition)</para>
          <indexterm zone="ch-system-util-linux-ng mkfs">
            <primary sortas="b-mkfs">mkfs</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mkfs.bfs">
        <term><command>mkfs.bfs</command></term>
        <listitem>
          <para>Creates a Santa Cruz Operations (SCO) bfs file system</para>
          <indexterm zone="ch-system-util-linux-ng mkfs.bfs">
            <primary sortas="b-mkfs.bfs">mkfs.bfs</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mkfs.cramfs">
        <term><command>mkfs.cramfs</command></term>
        <listitem>
          <para>Creates a cramfs file system</para>
          <indexterm zone="ch-system-util-linux-ng mkfs.cramfs">
            <primary sortas="b-mkfs.cramfs">mkfs.cramfs</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mkfs.minix">
        <term><command>mkfs.minix</command></term>
        <listitem>
          <para>Creates a Minix file system</para>
          <indexterm zone="ch-system-util-linux-ng mkfs.minix">
            <primary sortas="b-mkfs.minix">mkfs.minix</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mkswap">
        <term><command>mkswap</command></term>
        <listitem>
          <para>Initializes the given device or file to be used as a swap
          area</para>
          <indexterm zone="ch-system-util-linux-ng mkswap">
            <primary sortas="b-mkswap">mkswap</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="more">
        <term><command>more</command></term>
        <listitem>
          <para>A filter for paging through text one screen at a time</para>
          <indexterm zone="ch-system-util-linux-ng more">
            <primary sortas="b-more">more</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mount">
        <term><command>mount</command></term>
        <listitem>
          <para>Attaches the file system on the given device to a specified
          directory in the file-system tree</para>
          <indexterm zone="ch-system-util-linux-ng mount">
            <primary sortas="b-mount">mount</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="namei">
        <term><command>namei</command></term>
        <listitem>
          <para>Shows the symbolic links in the given pathnames</para>
          <indexterm zone="ch-system-util-linux-ng namei">
            <primary sortas="b-namei">namei</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pg">
        <term><command>pg</command></term>
        <listitem>
          <para>Displays a text file one screen full at a time</para>
          <indexterm zone="ch-system-util-linux-ng pg">
            <primary sortas="b-pg">pg</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pivot_root">
        <term><command>pivot_root</command></term>
        <listitem>
          <para>Makes the given file system the new root file system of the
          current process</para>
          <indexterm zone="ch-system-util-linux-ng pivot_root">
            <primary sortas="b-pivot_root">pivot_root</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ramsize">
        <term><command>ramsize</command></term>
        <listitem>
          <para>Sets the size of the RAM disk in a bootable image</para>
          <indexterm zone="ch-system-util-linux-ng ramsize">
            <primary sortas="b-ramsize">ramsize</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="raw">
        <term><command>raw</command></term>
        <listitem>
          <para>Used to bind a Linux-ng raw character device to a block
          device</para>
          <indexterm zone="ch-system-util-linux-ng raw">
            <primary sortas="b-raw">raw</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rdev">
        <term><command>rdev</command></term>
        <listitem>
          <para>Queries and sets the root device, among other things, in a
          bootable image</para>
          <indexterm zone="ch-system-util-linux-ng rdev">
            <primary sortas="b-rdev">rdev</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="readprofile">
        <term><command>readprofile</command></term>
        <listitem>
          <para>Reads kernel profiling information</para>
          <indexterm zone="ch-system-util-linux-ng readprofile">
            <primary sortas="b-readprofile">readprofile</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rename">
        <term><command>rename</command></term>
        <listitem>
          <para>Renames the given files, replacing a given string with
          another</para>
          <indexterm zone="ch-system-util-linux-ng rename">
            <primary sortas="b-rename">rename</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="renice">
        <term><command>renice</command></term>
        <listitem>
          <para>Alters the priority of running processes</para>
          <indexterm zone="ch-system-util-linux-ng renice">
            <primary sortas="b-renice">renice</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rev">
        <term><command>rev</command></term>
        <listitem>
          <para>Reverses the lines of a given file</para>
          <indexterm zone="ch-system-util-linux-ng rev">
            <primary sortas="b-rev">rev</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rootflags">
        <term><command>rootflags</command></term>
        <listitem>
          <para>Sets the rootflags in a bootable image</para>
          <indexterm zone="ch-system-util-linux-ng rootflags">
            <primary sortas="b-rootflags">rootflags</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="script">
        <term><command>script</command></term>
        <listitem>
          <para>Makes a typescript of a terminal session</para>
          <indexterm zone="ch-system-util-linux-ng script">
            <primary sortas="b-script">script</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="setfdprm">
        <term><command>setfdprm</command></term>
        <listitem>
          <para>Sets user-provided floppy disk parameters</para>
          <indexterm zone="ch-system-util-linux-ng setfdprm">
            <primary sortas="b-setfdprm">setfdprm</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="setsid">
        <term><command>setsid</command></term>
        <listitem>
          <para>Runs the given program in a new session</para>
          <indexterm zone="ch-system-util-linux-ng setsid">
            <primary sortas="b-setsid">setsid</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="setterm">
        <term><command>setterm</command></term>
        <listitem>
          <para>Sets terminal attributes</para>
          <indexterm zone="ch-system-util-linux-ng setterm">
            <primary sortas="b-setterm">setterm</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sfdisk">
        <term><command>sfdisk</command></term>
        <listitem>
          <para>A disk partition table manipulator</para>
          <indexterm zone="ch-system-util-linux-ng sfdisk">
            <primary sortas="b-sfdisk">sfdisk</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="swapoff">
        <term><command>swapoff</command></term>
        <listitem>
          <para>Disables devices and files for paging and swapping</para>
          <indexterm zone="ch-system-util-linux-ng swapoff">
            <primary sortas="b-swapoff">swapoff</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="swapon">
        <term><command>swapon</command></term>
        <listitem>
          <para>Enables devices and files for paging and swapping and
          lists the devices and files currently in use</para>
          <indexterm zone="ch-system-util-linux-ng swapon">
            <primary sortas="b-swapon">swapon</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tailf">
        <term><command>tailf</command></term>
        <listitem>
          <para>Tracks the growth of a log file. Displays the last 10 lines
          of a log file, then continues displaying any new entries in the
          log file as they are created</para>
          <indexterm zone="ch-system-util-linux-ng tailf">
            <primary sortas="b-tailf">tailf</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tunelp">
        <term><command>tunelp</command></term>
        <listitem>
          <para>Tunes the parameters of the line printer</para>
          <indexterm zone="ch-system-util-linux-ng tunelp">
            <primary sortas="b-tunelp">tunelp</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ul">
        <term><command>ul</command></term>
        <listitem>
          <para>A filter for translating underscores into escape sequences
          indicating underlining for the terminal in use</para>
          <indexterm zone="ch-system-util-linux-ng ul">
            <primary sortas="b-ul">ul</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="umount">
        <term><command>umount</command></term>
        <listitem>
          <para>Disconnects a file system from the system's file tree</para>
          <indexterm zone="ch-system-util-linux-ng umount">
            <primary sortas="b-umount">umount</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="vidmode">
        <term><command>vidmode</command></term>
        <listitem>
          <para>Sets the video mode in a bootable image</para>
          <indexterm zone="ch-system-util-linux-ng vidmode">
            <primary sortas="b-vidmode">vidmode</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="whereis">
        <term><command>whereis</command></term>
        <listitem>
          <para>Reports the location of the binary, source, and man page
          for the given command</para>
          <indexterm zone="ch-system-util-linux-ng whereis">
            <primary sortas="b-whereis">whereis</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="write">
        <term><command>write</command></term>
        <listitem>
          <para>Sends a message to the given user <emphasis>if</emphasis> that
          user has not disabled receipt of such messages</para>
          <indexterm zone="ch-system-util-linux-ng write">
            <primary sortas="b-write">write</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>