storm/minidlna
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add man pages contributed by Noel Butler <noelb@ausics.net>.

Browse Source
This commit is contained in:
Justin Maggard 2012-11-16 19:03:58 +00:00
parent 2521b3f238
commit bcaf6f3024
3 changed files with 262 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
NEWS
View File

@ -5,6 +5,7 @@
- Add configuration option for UUID.
- Add configuration option to specify the user to run as.
- Add support for limiting a media dir to multiple media types.
- Force a rescan if we detect a new or missing media_dir entry.
1.0.25 - Released 13-July-2012
--------------------------------

180
minidlna.conf.5 Normal file
View File

@ -0,0 +1,180 @@
.\" minidlna.conf man page
.TH minidlna.conf 5 "October 2012"
.SH NAME
minidlna
.SH DESCRIPTION
.PP
.B minidlna
is a light weight but very functional DLNA server. In most cases, the defaults
do not need modifications. The global configuration file is /etc/minidlna.conf
but local users without system root access can run minidlna with their own
configuration file.
.SH OPTIONS
.PP
The following are user configurable options in /etc/minidlna.conf
minidlna runs by default as user nobody, so make sure system permissions are
set correctly for read access to media and write access to cache and log dirs.
.IP "\fBfriendly_name\fP"
The name you want your media server seen as, EG: friendly_name=Home Media Server
.IP "\fBport\fP"
.nf
Port for HTTP (descriptions, SOAP, media transfer) traffic etc, defaults to 8200.
There should be no need to change this.
.fi
.IP "\fBnetwork_interface\fP"
Network interfaces to serve, comma delimited. Defaults to all.
.IP "\fBlistening_ip\fP"
Force to use specific IP address, not usually needed, minidlna will use the range
associated with network_interface.
.IP "\fBstrict_dlna\fP"
.nf
Set this 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.
.fi
.IP "\fBnotify_interval\fP"
Notify interval in seconds. The default is 895 seconds.
.IP "\fBminissdpdsocket\fP"
.nf
Specify the path to the MiniSSDPd socket,
EG: minissdpdsocket=/var/run/minissdpd.sock
.fi
.IP "\fBserial\fP"
.nf
Serial number the daemon will report to clients in its XML description.
Defaults to 12345678
.fi
.IP "\fBmodel\fP"
.nf
Model number the daemon will report to clients in its XML description.
Defaults to 1
.fi
.IP "\fBmedia_dir\fP"
.nf
Path to the directory containing the media files minidlna should share.
Use this option multile times if you have more than one directory to share.
Example:
media_dir=/opt/multimedia/videos
media_dir=/opt/multimedia/movies
.fi
.PP
You can also restrict an entry to a specific media type, you do this
by using the following syntax:
.nf
the letter 'A', 'V' or 'P', followed by a comma (',') followed by the path.
The meaning of the first letter is as follows:
'A' for audio files
'V' for video files
'P' for image files
For example, if you want to include only video files located
in /opt/multimedia/videos directory, and only music
in /opt/multimedia/music, then you would use
media_dir=V,/opt/multimedia/videos
media_dir=A,/opt/multimedia/music
Another example would be
media_dir=V,/opt/multimedia/videos
media_dir=V,/opt/multimedia/movies
media_dir=A,/opt/multimedia/music
Or, if you did not care what type it finds, then you could use
media_dir=/opt/multimedia/videos
media_dir=/opt/multimedia/movies
media_dir=/opt/multimedia/music
You can mix it up, find anything in music, but only Videos, in videos and movies
media_dir=V,/opt/multimedia/videos
media_dir=V,/opt/multimedia/movies
media_dir=/opt/multimedia/music
.fi
.IP "\fBpresentation_url\fP"
.nf
Default presentation url is http address on port 80
EG: presentation_url=http://www.mediaserver.lan/index.php
.fi
.IP "\fBdb_dir\fP"
Where minidlna stores the data files, including Album caceh files, by default
this is /var/cache/minidlna
.IP "\fBlog_dir\fP"
Path to the directory where the log file upnp-av.log should be stored, this
defaults to /var/log
.IP "\fBlog_level\fP"
Set this to change the verbosity of the information that is logged each
section can use a different level: off, fatal, error, warn, info, or debug
.nf
Example
log_level=general,artwork,database,inotify,scanner,metadata,http,ssdp,tivo=warn
.fi
.IP "\fBinotify\fP"
Set to 'yes' to enable inotify monitoring of the files under media_dir
to automatically discover new files. Set to 'no' to disable inotify.
.IP "\fBalbum_art_names\fP"
This should be a list of file names to check for when searching for album art
and names should be delimited with a forward slash ("/")
.nf
Example
album_art_names=Cover.jpg/cover.jpg/AlbumArtSmall.jpg/albumartsmall.jpg/AlbumArt.jpg
/albumart.jpg/Album.jpg/album.jpg/Folder.jpg/folder.jpg/Thumb.jpg/thumb.jpg
.fi
.IP "\fBenable_tivo\fP"
Set this to yes to enable support for streaming .jpg and .mp3 files to a TiVo
supporting HMO, default is no.
.IP "\fBroot_container\fP"
Use a different container as the root of the tree exposed to clients.
.nf
The possible values are:
'.' to use the standard container (this is the default)
'B' to use the "Browse Directory" container;
'M' to use the "Music" container;
'V' to use the "Video" container;
'P' to use the "Pictures" container.
If you specify 'B' and the client device is audio only, then
"Music/Folders" will be used as root container and you wont see Videos.
.fi
.SH VERSION
This manpage corresponds to minidlna version 1.0.25
.SH AUTHOR
.nf
minidlna developed by Justin Maggard https://sourceforge.net/projects/minidlna/
man page written by Noel Butler <noelb@ausics.net>
.fi
.SH LICENSE
GPL
.SH FILES
/etc/minidlna.conf
.SH SEE ALSO
minidlna(8)

81
minidlnad.8 Normal file
View File

@ -0,0 +1,81 @@
.\" minidlna man page
.TH minidlna 8 "October 2012"
.SH NAME
minidlna
.SH SYNOPSIS
minidlna options
.SH DESCRIPTION
.PP
.B minidlna
is a light weight but very functional DLNA upnp-AV server allowing easy
sharing of your media files including pictures to any capable device or
client on your local wired and wireless network. Common PC software like
totem is a good lightweight and fast choice for Linux/BSD, more fully
featured software for Linux, Windows and MAC is xbmc, also Mediahouse
on Android, and any media sharing capable DVR/TV etc.
.SH OPTIONS
.PP
.B minidlna's
options are normally set from the global /etc/minidlna.conf file.
.nf
But there may be times when you need to temporarily alter some of these options,
you can do this by running minidlna with the following command line switches.
.fi
.IP "\fB\-R\fR \fIRescan\fR"
This forces minidlna to rescan all of the media_dir directories.
.IP "\fB\-f\fR \fIconfig_file\fR"
Run minidlna with a different configuration file than the global default.
.IP "\fB\-a\fR \fIlistening_ip\fR"
If your machine has multiple IP's, you can tell minidlna to bind to a specific address.
.IP "\fB\-p\fR \fIport\fR"
Allows to run minidlna on a different port.
.IP "\fB\-w\fR \fIpresentation_url\fR"
Change the default presentation url address.
.IP "\fB\-d\fR \fIdebug\fR"
minidlna will run in the foreground with debug output.
.IP "\fB\-P\fR \fIpid_filename\fR"
Specify a location for the PID file.
.IP "\fB\-m\fR \fImodel\fR"
Force minidlna to report a specific model number.
.IP "\fB\-s\fR \fIserial\fR"
Force minidlna to report a specific serial number.
.IP "\fB\-t\fR \fInotify_interval\fR"
Change the notify interval, in seconds. Defaults to 895 seconds.
.IP "\fB\-h\fR \fIhelp\fR"
Show basic switch options for running minidlna.
.IP "\fB\-V\fR \fIVersion\fR"
Shows the program version number and exits.
.SH VERSION
This man page corresponds to minidlna version 1.0.25
.SH AUTHOR
.nf
minidlna developed by Justin Maggard https://sourceforge.net/projects/minidlna/
man page written by Noel Butler <noelb@ausics.net>
.fi
.SH LICENSE
GPL
.SH FILES
/usr/sbin/minidlna
.SH SEE ALSO
minidlna.conf(5)