minidlna/minidlna.conf.5

.\" Man page for minidlna.conf
.\"
.\" This man page is based on the comments in the default configuration file
.\" shipped with the minidlna source. Consequently, it is licensed under the
.\" GPLv2.
.\"
.\" Copyright (C) 2009 Justin Maggard <jmaggard@users.sourceforge.net>
.\" Copyright (C) 2010 Benoît Knecht <benoit.knecht@fsfe.org>
.\"
.\"    This package is free software; you can redistribute it and/or modify
.\"    it under the terms of the GNU General Public License version 2 as
.\"    published by the Free Software Foundation.
.\"
.\"    This package 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 General Public License for more details.
.\"
.\"    You should have received a copy of the GNU General Public License
.\"    along with this program. If not, see <http://www.gnu.org/licenses/>
.\"
.\" On Debian systems, the complete text of the GNU General
.\" Public License version 2 can be found in "/usr/share/common-licenses/GPL-2".
.Dd 22 October, 2010
.Dt MINIDLNA.CONF \&5 "File Formats Manual"
.Os Debian
.Sh NAME
.Nm minidlna.conf
.Nd MiniDLNA server configuration file
.Sh SYNOPSIS
.Nm /etc/minidlna.conf
.Sh DESCRIPTION
.Xr minidlna 1
reads configuration options from the system-wide configuration file
.Pa /etc/minidlna.conf ,
or the file specified with
.Fl f
on the command line. The file contains keyword-argument pairs, one per line.
Lines starting with
.Ql #
and empty lines are interpreted as comments.
.Pp
The possible
keywords and their meanings are as follows:
.Bl -tag -width Ds
.It Cm album_art_names
List of filenames to check for when searching for album art cache, separated by
forward slashes
.Pq Ql / .
.It Cm db_dir
Path to the directory
.Nm minidlna
should use to store its database and album art cache. Uses
.Pa /var/lib/minidlna
by default.
.It Cm enable_tivo
Set to
.Ql yes
to enable support for streaming JPEG and mp3 files to a TiVo supporting HMO.
Set to
.Ql no
otherwise.
.It Cm friendly_name
Customize the name that the
.Nm minidlna
server sends to clients.
.It Cm inotify
Set to
.Ql yes
to enable inotify monitoring of the files under
.Cm media_dir
to automatically discover new files. Set to
.Ql no
to disable inotify.
.It Cm log_dir
Path to the directory where the log file should be stored. Defaults to
.Pa /var/log .
.It Cm media_dir
Path to the directory containing the media files the
.Nm minidlna
server should share. Use this option several times if you have more than one
directory to share. To restrict a path to one specific media type, you can use
the following syntax: the letter
.Ql A ,
.Ql V
or
.Ql P ,
followed by a comma
.Pq Ql \&,
followed by the path. The meaning of the first letter is as follows:
.Bl -bullet -offset indent -compact
.It
.Ql A
for audio files;
.It
.Ql V
for video files;
.It
.Ql P
for image files.
.El
For example, if you want to include only video files located under the
.Pa /opt/media/videos
directory, you would use
.Cm media_dir=V,/opt/media/videos .
.It Cm model_number
Set the model number reported to clients.
.It Cm network_interface
Network interface to bind to.
.It Cm notify_interval
Set the notify interval, in seconds. The default is 895 seconds.
.It Cm port
Port for HTTP traffic. Defaults to port 80.
.It Cm presentation_url
.\" TODO: Needs a better description.
Define the presentation URL.
.It Cm serial
Set the serial number reported to clients.
.It Cm strict_dlna
Set to
.Ql yes
to strictly adhere to DLNA standards. This will allow server-side downscaling
of very large JPEG images, which may hurt JPEG serving performance on (at
least) Sony DLNA products. Set to
.Ql no
otherwise.
.El
.Sh FILES
.Bl -tag -width Ds
.It Pa /etc/minidlna.conf
System-wide default configuration file.
.El
.Sh SEE ALSO
.Xr minidlna 1