← Back to branch summary

~vanvugt/+junk/mediatomb

« back to all changes in this revision

Viewing changes to doc/mediatomb.1

  • 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:
doc/mediatomb.1
1
1
.\"     Title: MEDIATOMB
2
2
.\"    Author: <collabname>Sergey Bostandzhyan</collabname>
3
 
.\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
4
 
.\"      Date: 2007.05.27
 
3
.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
 
4
.\"      Date: 2008-02-23
5
5
.\"    Manual: User commands
6
 
.\"    Source: MediaTomb 0.10.0
 
6
.\"    Source: MediaTomb 0.11.0
7
7
.\"
8
 
.TH "MEDIATOMB" "1" "2007\-05\-27" "MediaTomb 0.10.0" "User commands"
 
8
.TH "MEDIATOMB" "1" "2008\-02\-23" "MediaTomb 0.11.0" "User commands"
9
9
.\" disable hyphenation
10
10
.nh
11
11
.\" disable justification (adjust text to left margin only)
21
21
.SH "OPTIONS"
22
22
.PP
23
23
\fB\-i\fR, \fB\-\-ip\fR
24
 
.RS 3n
 
24
.RS 4
25
25
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.
26
26
.RE
27
27
.PP
28
28
\fB\-e\fR, \fB\-\-interface\fR
29
 
.RS 3n
 
29
.RS 4
30
30
The server will bind to the given network interface, currently we can only bind to one interface at a time.
31
31
.RE
32
32
.PP
33
33
\fB\-p\fR, \fB\-\-port\fR
34
 
.RS 3n
 
34
.RS 4
35
35
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.
36
36
.RE
37
37
.PP
38
38
\fB\-c\fR, \fB\-\-config\fR
39
 
.RS 3n
 
39
.RS 4
40
40
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.
41
41
.RE
42
42
.PP
43
43
\fB\-d\fR, \fB\-\-daemon\fR
44
 
.RS 3n
 
44
.RS 4
45
45
Run the server in background, MediaTomb will shutdown on SIGTERM, SIGINT and restart on SIGHUP.
46
46
.RE
47
47
.PP
48
48
\fB\-m\fR, \fB\-\-home\fR
49
 
.RS 3n
 
49
.RS 4
50
50
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.
51
51
.sp
52
52
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"
53
53
.RE
54
54
.PP
55
55
\fB\-f\fR, \fB\-\-cfgdir\fR
56
 
.RS 3n
 
56
.RS 4
57
57
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.
58
58
.RE
59
59
.PP
60
60
\fB\-P\fR, \fB\-\-pidfile\fR
61
 
.RS 3n
 
61
.RS 4
62
62
Specify a file that will hold the server process ID, the filename must be absolute.
63
63
.RE
64
64
.PP
65
65
\fB\-u\fR, \fB\-\-user\fR
66
 
.RS 3n
 
66
.RS 4
67
67
Run MediaTomb under the specified user name, this is especially useful in combination with the daemon mode.
68
68
.RE
69
69
.PP
70
70
\fB\-g\fR, \fB\-\-group\fR
71
 
.RS 3n
 
71
.RS 4
72
72
Run MediaTomb under the specified group, this is especially useful in combination with the daemon mode.
73
73
.RE
74
74
.PP
75
75
\fB\-a\fR, \fB\-\-add\fR
76
 
.RS 3n
 
76
.RS 4
77
77
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.
78
78
.RE
79
79
.PP
80
80
\fB\-l\fR, \fB\-\-logfile\fR
81
 
.RS 3n
 
81
.RS 4
82
82
Do not output log messages to stdout, but redirect everything to a specified file.
83
83
.RE
84
84
.PP
85
85
\fB\-h\fR, \fB\-\-help\fR
86
 
.RS 3n
 
86
.RS 4
87
87
Print a summary about the available command line options.
88
88
.RE
89
89
.SH "AUTHORS"
94
94
.SH "COPYRIGHT"
95
95
Copyright \(co 2005 Gena Batsyan, Sergey Bostandzhyan
96
96
.br
97
 
Copyright \(co 2006\-2007 Gena Batsyan, Sergey Bostandzhyan, Leonhard Wimmer
 
97
Copyright \(co 2006\-2008 Gena Batsyan, Sergey Bostandzhyan, Leonhard Wimmer
98
98
.br
99
99
.PP
100
100
This manual page is part of MediaTomb.