← Back to branch summary

~ubuntu-branches/ubuntu/vivid/mediatomb/vivid

« back to all changes in this revision

Viewing changes to debian/extras/manpage.xml

  • Committer: Bazaar Package Importer
  • Author(s): Andres Mejia
  • Date: 2008-03-02 13:09:16 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20080302130916-zlljdze3kt7vuq4b
Tags: 0.11.0-1
* New upstream release.
* Include message about which inotify headers will be used when enabling
  inotify runtime support.
* Fixed error with use of INTERFACE in init script. Also removed use of -m
  option.
* Including new config.xml options.
* Added more build dependencies for new upstream release.
* Removed build dependency of libid3-dev, taglib is now preferred.
* mediatomb.xpm and manpage.xml is now included in orig tarball.
* inotify patch is not needed anymore.
* md5 patch has been committed upstream and is no longer needed. Also removed
  README.Debian.
* TwinHelix PNG fix is now used. Removed from TODO.
* Adding dependency of iceweasel for mediatomb package.
* Updated copyright file.
* Updated watch file.
* Updated rules file for proper configure options.

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/extras/manpage.xml
1
 
<?xml version='1.0' encoding='ISO-8859-1'?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3
 
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4
 
<refentry>
5
 
    <refentryinfo>
6
 
        <title>User commands</title>
7
 
        <productname>MediaTomb</productname>
8
 
        <productnumber>0.10.0</productnumber>
9
 
        <date>2007-05-27</date>
10
 
        <address>contact@mediatomb.cc</address>
11
 
        <authorgroup>
12
 
            <collab><collabname>Sergey Bostandzhyan</collabname></collab>
13
 
            <collab><collabname>Leonhard Wimmer</collabname></collab>
14
 
        </authorgroup>
15
 
        <copyright>
16
 
            <year>2005</year>
17
 
            <holder>Gena Batsyan</holder>
18
 
            <holder>Sergey Bostandzhyan</holder>
19
 
        </copyright>
20
 
        <copyright>
21
 
            <year>2006-2007</year>
22
 
            <holder>Gena Batsyan</holder>
23
 
            <holder>Sergey Bostandzhyan</holder>
24
 
            <holder>Leonhard Wimmer</holder>
25
 
        </copyright>
26
 
        <legalnotice>
27
 
            <para>This manual page is part of MediaTomb.</para>
28
 
            <para>Permission is granted to copy, distribute and/or modify this document under
29
 
          the terms of the <acronym>GNU</acronym> General Public License version 2 as published by the Free Software Foundation.</para>
30
 
        </legalnotice>
31
 
    </refentryinfo>
32
 
    <refmeta>
33
 
        <refentrytitle>MEDIATOMB</refentrytitle>
34
 
        <manvolnum>1</manvolnum>
35
 
    </refmeta>
36
 
    <refnamediv>
37
 
        <refname>mediatomb</refname>
38
 
        <refpurpose>UPnP MediaServer</refpurpose>
39
 
    </refnamediv>
40
 
    <refsynopsisdiv>
41
 
        <cmdsynopsis>
42
 
            <command>mediatomb</command>
43
 
 
44
 
            <arg>
45
 
                <option>-i <replaceable>IP address</replaceable>
46
 
                </option>
47
 
            </arg>
48
 
 
49
 
            <arg>
50
 
                <option>-e <replaceable>interface</replaceable>
51
 
                </option>
52
 
            </arg>
53
 
 
54
 
            <arg>
55
 
                <option>-p <replaceable>port</replaceable>
56
 
                </option>
57
 
            </arg>
58
 
 
59
 
            <arg>
60
 
                <option>-c <replaceable>config file</replaceable>
61
 
                </option>
62
 
            </arg>
63
 
 
64
 
            <arg>
65
 
                <option>-d</option>
66
 
            </arg>
67
 
 
68
 
            <arg>
69
 
                <option>-m <replaceable>home dir</replaceable>
70
 
                </option>
71
 
            </arg>
72
 
 
73
 
            <arg>
74
 
                <option>-f <replaceable>config dir</replaceable>
75
 
                </option>
76
 
            </arg>
77
 
 
78
 
            <arg>
79
 
                <option>-P <replaceable>PID file</replaceable>
80
 
                </option>
81
 
            </arg>
82
 
 
83
 
            <arg>
84
 
                <option>-u <replaceable>user</replaceable>
85
 
                </option>
86
 
            </arg>
87
 
 
88
 
            <arg>
89
 
                <option>-g <replaceable>group</replaceable>
90
 
                </option>
91
 
            </arg>
92
 
 
93
 
            <arg>
94
 
                <option>-a <replaceable>path</replaceable>
95
 
                </option>
96
 
            </arg>
97
 
 
98
 
            <arg>
99
 
                <option>-l <replaceable>logfile</replaceable>
100
 
                </option>
101
 
            </arg>
102
 
 
103
 
            <arg>
104
 
                <option>-h</option>
105
 
            </arg>
106
 
 
107
 
        </cmdsynopsis>
108
 
    </refsynopsisdiv>
109
 
    <refsect1>
110
 
        <title>DESCRIPTION</title>
111
 
 
112
 
        <para>This manual page describes the command line parameters for
113
 
        MediaTomb. For a detailed documentation please see the README file which
114
 
        is distributed with MediaTomb or visit http://mediatomb.cc/.</para>
115
 
    </refsect1>
116
 
    <refsect1>
117
 
        <title>OPTIONS</title>
118
 
 
119
 
        <variablelist>
120
 
 
121
 
            <varlistentry>
122
 
                <term>
123
 
                    <option>-i</option>,
124
 
                    <option>--ip</option>
125
 
                </term>
126
 
                <listitem>
127
 
                    <para>The server will bind to the given IP address, currently we can not bind to
128
 
                    multiple interfaces so binding to 0.0.0.0 will not be possible.</para>
129
 
                </listitem>
130
 
            </varlistentry>
131
 
 
132
 
            <varlistentry>
133
 
                <term>
134
 
                    <option>-e</option>,
135
 
                    <option>--interface</option>
136
 
                </term>
137
 
                <listitem>
138
 
                    <para>The server will bind to the given network interface, currently we can only bind
139
 
                    to one interface at a time.</para>
140
 
                </listitem>
141
 
            </varlistentry>
142
 
 
143
 
            <varlistentry>
144
 
                <term>
145
 
                    <option>-p</option>,
146
 
                    <option>--port</option>
147
 
                </term>
148
 
                <listitem>
149
 
                    <para>Specify the server port that will be used for the web user interface, for
150
 
                    serving media and for UPnP requests, minimum allowed value is 49152. If this
151
 
                    option is omitted a default port will be chosen, however, in this case it is
152
 
                    possible that the port will change upon server restart.</para>
153
 
                </listitem>
154
 
            </varlistentry>
155
 
 
156
 
            <varlistentry>
157
 
                <term>
158
 
                    <option>-c</option>,
159
 
                    <option>--config</option>
160
 
                </term>
161
 
                <listitem>
162
 
                    <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
163
 
                    name and location of your choice. The file name must be absolute.</para>
164
 
                </listitem>
165
 
            </varlistentry>
166
 
 
167
 
            <varlistentry>
168
 
                <term>
169
 
                    <option>-d</option>,
170
 
                    <option>--daemon</option>
171
 
                </term>
172
 
                <listitem>
173
 
                    <para>Run the server in background, MediaTomb will shutdown on SIGTERM, SIGINT and
174
 
                    restart on SIGHUP.</para>
175
 
                </listitem>
176
 
            </varlistentry>
177
 
 
178
 
            <varlistentry>
179
 
                <term>
180
 
                    <option>-m</option>,
181
 
                    <option>--home</option>
182
 
                </term>
183
 
                <listitem>
184
 
                    <para>Specify an alternative home directory. By default MediaTomb will try to
185
 
                    retrieve the users home directory from the environment, then it will look for a
186
 
                    .mediatomb directory in users home. If .mediatomb was found we will try to find
187
 
                    the default configuration file (config.xml), if not found we will create both,
188
 
                    the .mediatomb directory and the default config file.</para>
189
 
                    
190
 
                    <para>This option is useful in two cases: when the home directory can not be
191
 
                    retrieved from the environment (in this case you could also use -c to point
192
 
                    MediaTomb to your configuration file or when you want to create a new
193
 
                    configuration in a non standard location (for example, when setting up daemon
194
 
                    mode). In the latter case you can combine this parameter with the parameter
195
 
                    described in Section 5.6, "Config Directory"</para>
196
 
                </listitem>
197
 
            </varlistentry>
198
 
 
199
 
            <varlistentry>
200
 
                <term>
201
 
                    <option>-f</option>,
202
 
                    <option>--cfgdir</option>
203
 
                </term>
204
 
                <listitem>
205
 
                <para>The default configuration directory is combined out of the users home and the
206
 
                default that equals to .mediatomb, this option allows you to override the
207
 
                default directory naming. This is useful when you want to setup the server in a
208
 
                nonstandard location, but want that the default configuration to be written by
209
 
                the server.
210
 
                </para>
211
 
                </listitem>
212
 
            </varlistentry>
213
 
 
214
 
            <varlistentry>
215
 
                <term>
216
 
                    <option>-P</option>,
217
 
                    <option>--pidfile</option>
218
 
                </term>
219
 
                <listitem>
220
 
                    <para>Specify a file that will hold the server process ID, the filename must be
221
 
                    absolute.</para>
222
 
                </listitem>
223
 
            </varlistentry>
224
 
 
225
 
            <varlistentry>
226
 
                <term>
227
 
                    <option>-u</option>,
228
 
                    <option>--user</option>
229
 
                </term>
230
 
                <listitem>
231
 
                    <para>Run MediaTomb under the specified user name, this is especially useful in
232
 
                    combination with the daemon mode.</para>
233
 
                </listitem>
234
 
            </varlistentry>
235
 
 
236
 
            <varlistentry>
237
 
                <term>
238
 
                    <option>-g</option>,
239
 
                    <option>--group</option>
240
 
                </term>
241
 
                <listitem>
242
 
                    <para>Run MediaTomb under the specified group, this is especially useful in
243
 
                    combination with the daemon mode.</para>
244
 
                </listitem>
245
 
            </varlistentry>
246
 
 
247
 
            <varlistentry>
248
 
                <term>
249
 
                    <option>-a</option>,
250
 
                    <option>--add</option>
251
 
                </term>
252
 
                <listitem>
253
 
                    <para>Add the specified directory or file name to the database without UI
254
 
                    interaction. The path must be absolute, if path is a directory then it will be
255
 
                    added recursively. If path is a file, then only the given file will be
256
 
                    imported.</para>
257
 
                </listitem>
258
 
            </varlistentry>
259
 
 
260
 
            <varlistentry>
261
 
                <term>
262
 
                    <option>-l</option>,
263
 
                    <option>--logfile</option>
264
 
                </term>
265
 
                <listitem>
266
 
                    <para>Do not output log messages to stdout, but redirect everything to a specified
267
 
                    file.</para>
268
 
                </listitem>
269
 
            </varlistentry>
270
 
 
271
 
            <varlistentry>
272
 
                <term>
273
 
                    <option>-h</option>,
274
 
                    <option>--help</option>
275
 
                </term>
276
 
                <listitem>
277
 
                    <para>Print a summary about the available command line options.</para>
278
 
                </listitem>
279
 
            </varlistentry>
280
 
        </variablelist>
281
 
    </refsect1>
282
 
</refentry>
283