[packages/minidlna.git] / minidlna.1

.\" Man page for minidlna
.\"
.\" Copyright (C) 2010-2011 Benoît Knecht <benoit.knecht@fsfe.org>
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.Dd July 21, 2012
.Dt MINIDLNA \&1 "General Commands Manual"
.Os Debian
.Sh NAME
.Nm minidlna
.Nd lightweight DLNA/UPnP-AV server
.Sh SYNOPSIS
.Nm
.Op Fl f Ar config_file
.Op Fl d
.Op Fl v
.Op Fl a Ar ip_address
.Op Fl i Ar interface
.Op Fl p Ar port
.Op Fl s Ar serial
.Op Fl m Ar model_number
.Op Fl t Ar notify_interval
.Op Fl P Ar pid_filename
.Op Fl w Ar url
.Op Fl L
.Op Fl R
.Pp
.Nm
.Op Fl h \*[Ba] Fl V
.Sh DESCRIPTION
The
.Nm
daemon is a DLNA/UPnP-AV server sharing media files (video, music and pictures)
to clients on your network. Clients are typically multimedia players such as
vlc, totem and xbmc, and devices such as portable media players, smartphones,
televisions, video game entertainment systems and blu-ray players.
.Pp
By default,
.Nm minidlna
listens on all the network interfaces (except loopback) for clients. This
behavior can be changed on the command-line using the
.Fl a
or
.Fl i
options, or in the configuration file through the
.Cm listening_ip
or
.Cm network_interface
options
.Pq see Xr minidlna.conf 5 for details .
.Sh OPTIONS
All the options below
.Pq except Fl f
can also be set in a configuration file, as described in
.Xr minidlna.conf 5 .
.Bl -tag -width Ds
.It Fl a Ar ip_address
IP address to listen on
.Pq e.g. 198.51.100.1/24 .
If the mask is omitter, it defaults to /24. Can be specified more than once.
.It Fl d
Activate debug mode (do not daemonize).
.It Fl f Ar config_file
Specify the location of the configuration file. Uses
.Pa /etc/minidlna.conf
by default.
.It Fl h
Show help and exit.
.It Fl i Ar interface
Network interface to listen on. Can be specified more than once.
.It Fl L
Do not create playlists.
.It Fl m Ar model_number
Model number the daemon will report to clients in its XML description.
.It Fl P Ar pid_filename
PID file to use; the default is
.Pa /run/minidlna.pid .
.It Fl p Ar port
Port number to listen on.
.It Fl R
Forces a full rescan of the media files.
.It Fl s Ar serial
Serial number the daemon will report to clients in its XML description.
.It Fl t Ar notify_interval
Notify interval, in seconds; defaults to 895 seconds.
.It Fl V
Show the program version and exit.
.It Fl v
Verbose output.
.It Fl w Ar url
Sets the presentation url; the default is http address.
.El
.Sh FILES
.Bl -tag -width Ds -compact
.It Pa /etc/minidlna.conf
Default system-wide configuration file. See
.Xr minidlna.conf 5
for details on the syntax.
.El
.Sh SEE ALSO
.Xr minidlna.conf 5
Commit	Line	Data
3cd6bb51 AF	1	.\" Man page for minidlna
	2	.\"
	3	.\" Copyright (C) 2010-2011 Benoît Knecht <benoit.knecht@fsfe.org>
	4	.\"
	5	.\" Redistribution and use in source and binary forms, with or without
	6	.\" modification, are permitted provided that the following conditions
	7	.\" are met:
	8	.\" 1. Redistributions of source code must retain the above copyright
	9	.\" notice, this list of conditions and the following disclaimer.
	10	.\" 2. Redistributions in binary form must reproduce the above copyright
	11	.\" notice, this list of conditions and the following disclaimer in the
	12	.\" documentation and/or other materials provided with the distribution.
	13	.\" 3. Neither the name of the University nor the names of its contributors
	14	.\" may be used to endorse or promote products derived from this software
	15	.\" without specific prior written permission.
	16	.Dd July 21, 2012
	17	.Dt MINIDLNA \&1 "General Commands Manual"
	18	.Os Debian
	19	.Sh NAME
	20	.Nm minidlna
	21	.Nd lightweight DLNA/UPnP-AV server
	22	.Sh SYNOPSIS
	23	.Nm
	24	.Op Fl f Ar config_file
	25	.Op Fl d
	26	.Op Fl v
	27	.Op Fl a Ar ip_address
	28	.Op Fl i Ar interface
	29	.Op Fl p Ar port
	30	.Op Fl s Ar serial
	31	.Op Fl m Ar model_number
	32	.Op Fl t Ar notify_interval
	33	.Op Fl P Ar pid_filename
	34	.Op Fl w Ar url
	35	.Op Fl L
	36	.Op Fl R
	37	.Pp
	38	.Nm
	39	.Op Fl h \*[Ba] Fl V
	40	.Sh DESCRIPTION
	41	The
	42	.Nm
	43	daemon is a DLNA/UPnP-AV server sharing media files (video, music and pictures)
	44	to clients on your network. Clients are typically multimedia players such as
	45	vlc, totem and xbmc, and devices such as portable media players, smartphones,
	46	televisions, video game entertainment systems and blu-ray players.
	47	.Pp
	48	By default,
	49	.Nm minidlna
	50	listens on all the network interfaces (except loopback) for clients. This
	51	behavior can be changed on the command-line using the
	52	.Fl a
	53	or
	54	.Fl i
	55	options, or in the configuration file through the
	56	.Cm listening_ip
	57	or
	58	.Cm network_interface
	59	options
	60	.Pq see Xr minidlna.conf 5 for details .
	61	.Sh OPTIONS
	62	All the options below
	63	.Pq except Fl f
	64	can also be set in a configuration file, as described in
65	.Xr minidlna.conf 5 .
66	.Bl -tag -width Ds
67	.It Fl a Ar ip_address
68	IP address to listen on
69	.Pq e.g. 198.51.100.1/24 .
70	If the mask is omitter, it defaults to /24. Can be specified more than once.
71	.It Fl d
72	Activate debug mode (do not daemonize).
73	.It Fl f Ar config_file
74	Specify the location of the configuration file. Uses
75	.Pa /etc/minidlna.conf
76	by default.
77	.It Fl h
78	Show help and exit.
79	.It Fl i Ar interface
80	Network interface to listen on. Can be specified more than once.
81	.It Fl L
82	Do not create playlists.
83	.It Fl m Ar model_number
84	Model number the daemon will report to clients in its XML description.
85	.It Fl P Ar pid_filename
86	PID file to use; the default is
87	.Pa /run/minidlna.pid .
88	.It Fl p Ar port
89	Port number to listen on.
90	.It Fl R
91	Forces a full rescan of the media files.
92	.It Fl s Ar serial
93	Serial number the daemon will report to clients in its XML description.
94	.It Fl t Ar notify_interval
95	Notify interval, in seconds; defaults to 895 seconds.
96	.It Fl V
97	Show the program version and exit.
98	.It Fl v
99	Verbose output.
100	.It Fl w Ar url
101	Sets the presentation url; the default is http address.
102	.El
103	.Sh FILES
104	.Bl -tag -width Ds -compact
105	.It Pa /etc/minidlna.conf
106	Default system-wide configuration file. See
107	.Xr minidlna.conf 5
108	for details on the syntax.
109	.El
110	.Sh SEE ALSO
111	.Xr minidlna.conf 5