source: general/sysutils/mc.xml@ 3cd5c69

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

  <!ENTITY mc-download-http "http://www.ibiblio.org/pub/Linux/utils/file/managers/mc/mc-&mc-version;.tar.gz">
  <!ENTITY mc-download-ftp  "ftp://ftp.uni-koeln.de/util/shell/mc-&mc-version;.tar.gz">
  <!ENTITY mc-md5sum        "18b20db6e40480a53bac2870c56fc3c4">
  <!ENTITY mc-size          "3.8 MB">
  <!ENTITY mc-buildsize     "29 MB">
  <!ENTITY mc-time          "0.4 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">mc-&mc-version;.tar</keyword>
      <keyword role="ftpdir">mc</keyword>
    </keywordset>
  </sect1info>

  <title>MC-&mc-version;</title>

  <indexterm zone="mc">
    <primary sortas="a-MC">MC</primary>
  </indexterm>

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

    <para><application>MC</application> (Midnight Commander) is a text-mode
    full-screen file manager and visual shell. It provides a clear,
    user-friendly, and somewhat protected interface to a Unix system while
    making many frequent file operations more efficient and preserving the
    full power of the command prompt.</para>

    <caution>
      <para>The <application>MC</application> package has some issues when
      used in a UTF-8 based locale. For a full explanation of the issues, see
      the <xref linkend="locale-mc"/> section of the
      <xref linkend="locale-issues"/>.</para>
    </caution>

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

    <bridgehead renderas="sect3">MC Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="GLib"/> or
    <xref linkend="glib2"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="gpm"/>,
    X (<xref linkend="xfree86"/> or <xref linkend="xorg"/>),
    <xref linkend="samba3"/>,
    <xref linkend="slang"/>,
    <xref linkend="zip"/>,
    <xref linkend="unzip"/>, and
    <xref linkend="gnome-libs"/></para>

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr &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="configuration">
    <title>Configuring MC</title>

    <sect3 id="mc-config">
      <title>Config Files</title>

      <para><filename>~/.mc/*</filename></para>

      <indexterm zone="mc mc-config">
        <primary sortas="e-AA..mc/*">~/..mc/*</primary>
      </indexterm>

    </sect3>

    <sect3>
      <title>Configuration Information</title>

      <para>The <filename class="directory">~/.mc</filename> directory and
      its contents are created when you start <command>mc</command> for the
      first time. Then you can edit the main <filename>~/.mc/ini</filename>
      configuration file manually or through the <application>MC</application>
      shell. Consult the mc(1) man page for details.</para>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>mc, mcedit, mcmfmt, and mcview</seg>
        <seg>None</seg>
        <seg>/usr/share/mc and /usr/lib/mc</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="mc-prog">
        <term><command>mc</command></term>
        <listitem>
          <para>is a visual shell.</para>
          <indexterm zone="mc mc-prog">
            <primary sortas="b-mc">mc</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mcedit">
        <term><command>mcedit</command></term>
        <listitem>
          <para>is an internal file editor.</para>
          <indexterm zone="mc mcedit">
            <primary sortas="b-mcedit">mcedit</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mcview">
        <term><command>mcview</command></term>
        <listitem>
          <para>is an internal file viewer.</para>
          <indexterm zone="mc mcview">
            <primary sortas="b-mcview">mcview</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>