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

Add another man page, for mlm-analyze.

parent 29b2fa4b

Makefile.am

+1 −0
Changes for Makefile.am: 1 added line, 0 removed lines.
Original line number Diff line number Diff line
@@ -278,6 +278,7 @@ DISTCLEANFILES = \ 


if ENABLE_MANPAGES

man1_MANS =							\

	man/mlm-analyze.1					\

	man/mlm-tags.1



XML_FILES = $(patsubst %.1,%.xml,$(man1_MANS))

man/meson.build

+13 −8
Changes for man/meson.build: 13 added lines, 8 removed lines.
Original line number Diff line number Diff line
@@ -5,42 +5,47 @@ xsltproc_flags = [ 
  '--nonet',

  '--xinclude',

  '--stringparam', 'man.output.quietly', '1',

  '--stringparam', 'man.authors.section.enabled', '0',

  '--stringparam',  'man.copyright.section.enabled', '0',

  '--stringparam', 'man.authors.section.enabled', '1',

  '--stringparam',  'man.copyright.section.enabled', '1',

  '--stringparam', 'mlm.version', meson.project_version(),

  '--path', meson.current_source_dir()

]



input_files = [

  'mlm-analyze.xml',

  'mlm-tags.xml'

]



output_man_files = [

  'mlm-analyze.1',

  'mlm-tags.1'

]



output_html_files = [

  'mlm-analyze.html',

  'mlm-tags.html'

]



mandir = join_paths(get_option('mandir'), 'man1')

htmldir = join_paths(get_option('datadir'), 'doc',

                     meson.project_name() + '-' + meson.project_version())



man_pages = custom_target('man-pages',

                          output: output_man_files,

                          input: input_files,

                          command: [ xsltproc,

                                     xsltproc_flags,

                                     '-o', '@OUTPUT@',

                                     '--output', 'man/',

                                     customman, '@INPUT@'],

                          install: true,

                          install_dir: join_paths(get_option('mandir'), 'man1')

                         )

                          install_dir: mandir)



html_pages = custom_target('html-pages',

                           output: output_html_files,

                           input: input_files,

                           command: [ xsltproc,

                                      xsltproc_flags,

                                      '-o', '@OUTPUT@',

                                      '--output', 'man/',

                                      customhtml, '@INPUT@'],

                           install: false,

                           install_dir: join_paths(get_option('mandir'), 'man1')

                          )
 
                           install_dir: htmldir)

man/mlm-analyze.xml

0 → 100644
+100 −0
Changes for man/mlm-analyze.xml: 100 added lines, 0 removed lines.
Original line number 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-analyze.xml - This file is part of mlm.



  Copyright © 2013-2017 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-analyze">



  <refentryinfo>

    <title>mlm-analyze</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-analyze</refentrytitle>

    <manvolnum>1</manvolnum>

  </refmeta>



  <refnamediv>

    <refname>mlm-analyze</refname>

    <refpurpose>Analyze MP3 standard tags in detail</refpurpose>

  </refnamediv>



  <refsynopsisdiv>

    <cmdsynopsis>

      <command>mlm-analyze</command>

      <arg choice="opt" rep="repeat">OPTION</arg>

      <arg choice="opt" rep="repeat">FILENAME</arg>

    </cmdsynopsis>

  </refsynopsisdiv>



  <refsect1>



    <title>Description</title>



    <para><filename>mlm-analyze</filename> is a command line tool to analyze in

    detail the standard tags of one or more MP3 files.</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>



    </variablelist>



  </refsect1>



  <refsect1>

    <title>See Also</title>

    <para>

      <citerefentry>

        <refentrytitle>mlm-copy</refentrytitle>

        <manvolnum>1</manvolnum>

      </citerefentry>,

      <citerefentry>

        <refentrytitle>mlm-tags</refentrytitle>

        <manvolnum>1</manvolnum>

      </citerefentry>.

    </para>

  </refsect1>



</refentry>

man/mlm-tags.xml

+21 −25
Changes for man/mlm-tags.xml: 21 added lines, 25 removed lines.
Original line number Diff line number Diff line
@@ -3,22 +3,22 @@ 
        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">



<!--

  This file is part of mlm.

  mlm-tags.xml - This file is part of mlm.



  Copyright 2013-2014 Canek Peláez Valdés

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



  mlm is free software; you can redistribute it and/or modify it

  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.



  mlm is distributed in the hope that it will be useful, but

  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 mlm; If not, see <http://www.gnu.org/licenses/>.

  along with this program; If not, see <http://www.gnu.org/licenses/>.

-->



<refentry id="mlm-tags">
@@ -49,7 +49,7 @@ 
  <refsynopsisdiv>

    <cmdsynopsis>

      <command>mlm-tags</command>

      <arg choice="opt" rep="repeat">OPTIONS</arg>

      <arg choice="opt" rep="repeat">OPTION</arg>

      <arg choice="opt" rep="repeat">FILENAME</arg>

    </cmdsynopsis>

  </refsynopsisdiv>
@@ -58,8 +58,8 @@ 


    <title>Description</title>



    <para><filename>mlm-tags</filename> is a command line tool to

    show and edit the standard tags of one or more MP3 files.</para>

    <para><filename>mlm-tags</filename> is a command line tool to show and edit

    the standard tags of one or more MP3 files.</para>



  </refsect1>
@@ -67,9 +67,8 @@ 


    <title>Options</title>



    <para>The following options are accepted. Except explicitly

    noted, all the options apply to all the filenames specified in

    the command line.</para>

    <para>The following options are accepted. Except explicitly noted, all the

    options apply to all the filenames specified in the command line.</para>



    <variablelist>
@@ -117,8 +116,8 @@ 
        <term><option>-y</option></term>

        <term><option>--year=YEAR</option></term>

        <listitem>

          <para>Set the release year for the album. Valid values:

          from 1900 to the current year, inclusive.</para>

          <para>Set the release year for the album. Valid values: from 1900 to

          the current year, inclusive.</para>

        </listitem>

      </varlistentry>
@@ -126,11 +125,10 @@ 
        <term><option>-n</option></term>

        <term><option>--track=TRACK</option></term>

        <listitem>

          <para>Set the track number. Valid values: from 1 to 99,

          inclusive. The track number cannot be greater than the

          track total, unless both are set at the same time, in

          which case the track total will be adjusted to be equal to

          the track number.</para>

          <para>Set the track number. Valid values: from 1 to 99, inclusive. The

          track number cannot be greater than the track total, unless both are

          set at the same time, in which case the track total will be adjusted

          to be equal to the track number.</para>

        </listitem>

      </varlistentry>
@@ -138,13 +136,11 @@ 
        <term><option>-#</option></term>

        <term><option>--total=TOTAL</option></term>

        <listitem>

          <para>Set the track total; the number of tracks on the

          album. Valid values: from 1 to 99, inclusive. The track

          total cannot be less than the track number, unless both

          are set at the same time, in which case the track total

          will be adjusted to be equal to the track number. The

          track total cannot be set if there is no track

          number.</para>

          <para>Set the track total; the number of tracks on the album. Valid

          values: from 1 to 99, inclusive. The track total cannot be less than

          the track number, unless both are set at the same time, in which case

          the track total will be adjusted to be equal to the track number. The

          track total cannot be set if there is no track number.</para>

        </listitem>

      </varlistentry>

src/tags/tags.vala

+1 −1
Changes for src/tags/tags.vala: 1 added line, 1 removed line.
Original line number Diff line number Diff line 
/* tags.vala - This file is part of mlm.

 *

 * Copyright © 2013 - 2016 Canek Peláez Valdés

 * Copyright © 2013 - 2017 Canek Peláez Valdés

 *

 * This program is free software: you can redistribute it and/or modify it under

 * the terms of the GNU General Public License as published by the Free Software