<?xml version='1.0' encoding='ISO-8859-1'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<refentry>
    <refentryinfo>
        <title>User commands</title>
        <productname>MediaTomb</productname>
        <productnumber>0.11.0</productnumber>
        <date>2008-02-23</date>
        <address>contact@mediatomb.cc</address>
        <authorgroup>
            <collab><collabname>Sergey Bostandzhyan</collabname></collab>
            <collab><collabname>Leonhard Wimmer</collabname></collab>
        </authorgroup>
        <copyright>
            <year>2005</year>
            <holder>Gena Batsyan</holder>
            <holder>Sergey Bostandzhyan</holder>
        </copyright>
        <copyright>
            <year>2006-2008</year>
            <holder>Gena Batsyan</holder>
            <holder>Sergey Bostandzhyan</holder>
            <holder>Leonhard Wimmer</holder>
        </copyright>
        <legalnotice>
            <para>This manual page is part of MediaTomb.</para>
            <para>Permission is granted to copy, distribute and/or modify this document under
          the terms of the <acronym>GNU</acronym> General Public License version 2 as published by the Free Software Foundation.</para>
        </legalnotice>
    </refentryinfo>
    <refmeta>
        <refentrytitle>MEDIATOMB</refentrytitle>
        <manvolnum>1</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>mediatomb</refname>
        <refpurpose>UPnP MediaServer</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <cmdsynopsis>
            <command>mediatomb</command>

            <arg>
                <option>-i <replaceable>IP address</replaceable>
                </option>
            </arg>

            <arg>
                <option>-e <replaceable>interface</replaceable>
                </option>
            </arg>

            <arg>
                <option>-p <replaceable>port</replaceable>
                </option>
            </arg>

            <arg>
                <option>-c <replaceable>config file</replaceable>
                </option>
            </arg>

            <arg>
                <option>-d</option>
            </arg>

            <arg>
                <option>-m <replaceable>home dir</replaceable>
                </option>
            </arg>

            <arg>
                <option>-f <replaceable>config dir</replaceable>
                </option>
            </arg>

            <arg>
                <option>-P <replaceable>PID file</replaceable>
                </option>
            </arg>

            <arg>
                <option>-u <replaceable>user</replaceable>
                </option>
            </arg>

            <arg>
                <option>-g <replaceable>group</replaceable>
                </option>
            </arg>

            <arg>
                <option>-a <replaceable>path</replaceable>
                </option>
            </arg>

            <arg>
                <option>-l <replaceable>logfile</replaceable>
                </option>
            </arg>
            
            <arg>
                <option>-D</option>
            </arg>
            
            <arg>
                <option>--compile-info</option>
            </arg>
            
            <arg>
                <option>--version</option>
            </arg>
            
            <arg>
                <option>-h</option>
            </arg>

        </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
        <title>DESCRIPTION</title>

        <para>This manual page describes the command line parameters for
        MediaTomb. For a detailed documentation please see the README file which
        is distributed with MediaTomb or visit http://mediatomb.cc/.</para>
    </refsect1>
    <refsect1>
        <title>OPTIONS</title>

        <variablelist>

            <varlistentry>
                <term>
                    <option>-i</option>,
                    <option>--ip</option>
                </term>
                <listitem>
                    <para>The server will bind to the given IP address, currently we can not bind to
                    multiple interfaces so binding to 0.0.0.0 will not be possible.</para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>
                    <option>-e</option>,
                    <option>--interface</option>
                </term>
                <listitem>
                    <para>The server will bind to the given network interface, currently we can only bind
                    to one interface at a time.</para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>
                    <option>-p</option>,
                    <option>--port</option>
                </term>
                <listitem>
                    <para>Specify the server port that will be used for the web user interface, for
                    serving media and for UPnP requests, minimum allowed value is 49152. If this
                    option is omitted a default port will be chosen, however, in this case it is
                    possible that the port will change upon server restart.</para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>
                    <option>-c</option>,
                    <option>--config</option>
                </term>
                <listitem>
                    <para>By default MediaTomb will search for a file named "config.xml" in the ~/.mediatomb directory. This option allows you to specify a config file by the
                    name and location of your choice. The file name must be absolute.</para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>
                    <option>-d</option>,
                    <option>--daemon</option>
                </term>
                <listitem>
                    <para>Run the server in background, MediaTomb will shutdown on SIGTERM, SIGINT and
                    restart on SIGHUP.</para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>
                    <option>-m</option>,
                    <option>--home</option>
                </term>
                <listitem>
                    <para>Specify an alternative home directory. By default MediaTomb will try to
                    retrieve the users home directory from the environment, then it will look for a
                    .mediatomb directory in users home. If .mediatomb was found we will try to find
                    the default configuration file (config.xml), if not found we will create both,
                    the .mediatomb directory and the default config file.</para>
                    
                    <para>This option is useful in two cases: when the home directory can not be
                    retrieved from the environment (in this case you could also use -c to point
                    MediaTomb to your configuration file or when you want to create a new
                    configuration in a non standard location (for example, when setting up daemon
                    mode). In the latter case you can combine this parameter with the parameter
                    described in Section 5.6, "Config Directory"</para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>
                    <option>-f</option>,
                    <option>--cfgdir</option>
                </term>
                <listitem>
                <para>The default configuration directory is combined out of the users home and the
                default that equals to .mediatomb, this option allows you to override the
                default directory naming. This is useful when you want to setup the server in a
                nonstandard location, but want that the default configuration to be written by
                the server.
                </para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>
                    <option>-P</option>,
                    <option>--pidfile</option>
                </term>
                <listitem>
                    <para>Specify a file that will hold the server process ID, the filename must be
                    absolute.</para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>
                    <option>-u</option>,
                    <option>--user</option>
                </term>
                <listitem>
                    <para>Run MediaTomb under the specified user name, this is especially useful in
                    combination with the daemon mode.</para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>
                    <option>-g</option>,
                    <option>--group</option>
                </term>
                <listitem>
                    <para>Run MediaTomb under the specified group, this is especially useful in
                    combination with the daemon mode.</para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>
                    <option>-a</option>,
                    <option>--add</option>
                </term>
                <listitem>
                    <para>Add the specified directory or file name to the database without UI
                    interaction. The path must be absolute, if path is a directory then it will be
                    added recursively. If path is a file, then only the given file will be
                    imported.</para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>
                    <option>-l</option>,
                    <option>--logfile</option>
                </term>
                <listitem>
                    <para>Do not output log messages to stdout, but redirect everything to a specified
                    file.</para>
                </listitem>
            </varlistentry>
            
            <varlistentry>
                <term>
                    <option>-D</option>,
                    <option>--debug</option>
                </term>
                <listitem>
                    <para>Enable debug log output.</para>
                </listitem>
            </varlistentry>
            
            <varlistentry>
                <term>
                    <option>--compile-info</option>
                </term>
                <listitem>
                    <para>Print the configuration summary (used libraried and enabled features) and exit.</para>
                </listitem>
            </varlistentry>
            
            <varlistentry>
                <term>
                    <option>--version</option>
                </term>
                <listitem>
                    <para>Print version information and exit.</para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>
                    <option>-h</option>,
                    <option>--help</option>
                </term>
                <listitem>
                    <para>Print a summary about the available command line options.</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsect1>
</refentry>

