glfs/postlfs/filesystems/jfs.xml

<?xml version="1.0" encoding="UTF-8"?>
<!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;

  <!ENTITY jfsutils-download-http "https://jfs.sourceforge.net/project/pub/jfsutils-&jfsutils-version;.tar.gz">
  <!ENTITY jfsutils-download-ftp  " ">
  <!ENTITY jfsutils-md5sum        "8809465cd48a202895bc2a12e1923b5d">
  <!ENTITY jfsutils-size          "532 KB">
  <!ENTITY jfsutils-buildsize     "8.9 MB">
  <!ENTITY jfsutils-time          "0.1 SBU">
]>

<sect1 id="jfsutils" xreflabel="jfsutils-&jfsutils-version;">
  <?dbhtml filename="jfsutils.html"?>


  <title>jfsutils-&jfsutils-version;</title>

  <indexterm zone="jfsutils">
    <primary sortas="a-jfsutils">jfsutils</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to jfsutils</title>

    <para>
      The <application>jfsutils</application> package contains administration
      and debugging tools for the jfs file system.
    </para>

    &lfs121_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&jfsutils-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&jfsutils-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &jfsutils-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &jfsutils-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &jfsutils-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &jfsutils-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch to fix issues exposed by GCC 10 and later:
          <ulink url="&patch-root;/jfsutils-&jfsutils-version;-gcc10_fix-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>


  </sect2>

  <sect2 role="kernel" id='jfsutils-kernel'>
    <title>Kernel Configuration</title>

    <para>
      Enable the following option in the kernel configuration
      and recompile the kernel:
    </para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="jfs-kernel.xml"/>

    <indexterm zone="jfsutils jfsutils-kernel">
      <primary sortas="d-jfsutils">JFS Utilities</primary>
    </indexterm>

  </sect2>

  <sect2 role="installation">
    <title>Installation of jfsutils</title>

    <para>
      First, fix some issues exposed by GCC 10 and later:
    </para>

<screen><userinput>patch -Np1 -i ../jfsutils-&jfsutils-version;-gcc10_fix-1.patch</userinput></screen>

    <para>
      Install <application>jfsutils</application> by running the following
      commands:
    </para>

<screen><userinput>sed -i "/unistd.h/a#include &lt;sys/types.h&gt;"    fscklog/extract.c &amp;&amp;
sed -i "/ioctl.h/a#include &lt;sys/sysmacros.h&gt;" libfs/devices.c   &amp;&amp;

./configure &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <command>sed ...</command>: Fixes building with glibc 2.28.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>fsck.jfs, jfs_debugfs, jfs_fsck, jfs_fscklog,
        jfs_logdump, jfs_mkfs, jfs_tune, mkfs.jfs </seg>
        <seg>None</seg>
        <seg>None</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="fsck.jfs">
        <term><command>fsck.jfs</command></term>
        <listitem>
          <para>
            is used to replay the JFS transaction log, check a
            JFS formatted device for errors, and fix any errors found
          </para>
          <indexterm zone="jfsutils fsck.jfs">
            <primary sortas="b-fsck.jfs">fsck.jfs</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jfs_fsck">
        <term><command>jfs_fsck</command></term>
        <listitem>
          <para>
            is a hard link to fsck.jfs
          </para>
          <indexterm zone="jfsutils jfs_fsck">
            <primary sortas="b-jfs_fsck">jfs_fsck</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mkfs.jfs">
        <term><command>mkfs.jfs</command></term>
        <listitem>
          <para>
            constructs an JFS file system
          </para>
          <indexterm zone="jfsutils mkfs.jfs">
            <primary sortas="b-mkfs.jfs">mkfs.jfs</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jfs_mkfs">
        <term><command>jfs_mkfs</command></term>
        <listitem>
          <para>
            is a hard link to mkfs.jfs
          </para>
          <indexterm zone="jfsutils jfs_mkfs">
            <primary sortas="b-jfs_mkfs">jfs_mkfs</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jfs_debugfs">
        <term><command>jfs_debugfs</command></term>
        <listitem>
          <para>
            is a program which can be used to perform various low-level
            actions on a JFS formatted device
          </para>
          <indexterm zone="jfsutils jfs_debugfs">
            <primary sortas="b-jfs_debugfs">jfs_debugfs</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jfs_fscklog">
        <term><command>jfs_fscklog</command></term>
        <listitem>
          <para>
            extracts a JFS fsck service log into a file and/or formats and
            displays the extracted file
          </para>
          <indexterm zone="jfsutils jfs_fscklog">
            <primary sortas="b-jfs_fscklog">jfs_fscklog</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jfs_logdump">
        <term><command>jfs_logdump</command></term>
        <listitem>
          <para>
            dumps the contents of the journal log from the specified
            JFS formatted device into output file ./jfslog.dmp
          </para>
          <indexterm zone="jfsutils jfs_logdump">
            <primary sortas="b-jfs_logdump">jfs_logdump</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jfs_tune">
        <term><command>jfs_tune</command></term>
        <listitem>
          <para>
            adjusts tunable file system parameters on JFS file systems
          </para>
          <indexterm zone="jfsutils jfs_tune">
            <primary sortas="b-jfs_tune">jfs_tune</primary>
          </indexterm>
        </listitem>
      </varlistentry>


    </variablelist>

  </sect2>

</sect1>