Commit de41d895 authored by Canek Peláez's avatar Canek Peláez
Browse files

Start of man page for the arranger.

parent 88a9c7c5
Loading
Loading
Loading
Loading

man/mlm-arrange.xml

0 → 100644
+121 −0
Original line number Original line Diff line number Diff line
<?xml version='1.0' encoding='UTF-8'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
  mlm-arrange.xml - This file is part of mlm.

  Copyright © 2013-2019 Canek Peláez Valdés

  This program is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with this program; If not, see <http://www.gnu.org/licenses/>.
-->

<refentry id="mlm-arrange">

  <refentryinfo>
    <title>mlm-arrange</title>
    <productname>mlm</productname>
    <authorgroup>
      <author>
        <contrib>Developer</contrib>
        <firstname>Canek</firstname>
        <surname>Peláez Valdés</surname>
        <email>canek@ciencias.unam.mx</email>
      </author>
    </authorgroup>
  </refentryinfo>

  <refmeta>
    <refentrytitle>mlm-arrange</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>mlm-arrange</refname>
    <refpurpose>Arrange MP3 files with Id3v2.4.0 tags</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>mlm-arrange</command>
      <arg choice="opt" rep="repeat">OPTION</arg>
      <arg choice="req" rep="norepeat">-o DIRECTORY</arg>
      <arg choice="opt" rep="repeat">FILENAME</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>

    <title>Description</title>

    <para><filename>mlm-arrange</filename> is a command line tool to arrange MP3
    files with Id3v2.4.0 tags into a specified directory. This is done by
    reading the <constant>artist</constant>, <constant>title</constant>, and
    <constant>album</constant> tags; the program will exit with an error message
    if one or more of the tags are missing. If available, the
    <constant>band</constant>, <constant>track</constant> and
    <constant>total</constant> tags are also used.</para>

    <para>With the available information, <command></command>
    </para>

  </refsect1>

  <refsect1>

    <title>Options</title>

    <para>The following options are accepted.</para>

    <variablelist>

      <varlistentry>
        <term><option>-h</option></term>
        <term><option>--help</option></term>
        <listitem>
          <para>Show help options.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-o</option></term>
        <term><option>--output=DIRECTORY</option></term>
        <listitem>
          <para>Set output directory.</para>
        </listitem>
      </varlistentry>

    </variablelist>

  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <citerefentry>
        <refentrytitle>mlm-analyze</refentrytitle>
        <manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>mlm-copy-tags</refentrytitle>
        <manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>mlm-tags</refentrytitle>
        <manvolnum>1</manvolnum>
      </citerefentry>.
    </para>
  </refsect1>

</refentry>