[packages/minidlna] Add man pages (from Debian)
wiget
wiget at pld-linux.org
Sun Nov 18 18:55:45 CET 2012
commit 3cd6bb5145b0ddf9a715bddfa957e4f83b8d2a22
Author: Artur Frysiak <artur at frysiak.net>
Date: Thu Nov 15 22:14:32 2012 +0100
Add man pages (from Debian)
minidlna.1 | 111 +++++++++++++++++++++++
minidlna.conf.5 | 269 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
minidlna.spec | 12 ++-
3 files changed, 391 insertions(+), 1 deletion(-)
---
diff --git a/minidlna.spec b/minidlna.spec
index 454fdbc..92e6ba2 100644
--- a/minidlna.spec
+++ b/minidlna.spec
@@ -8,6 +8,10 @@ Group: Networking/Daemons
Source0: http://downloads.sourceforge.net/minidlna/%{name}_%{version}_src.tar.gz
# Source0-md5: d966256baf2f9b068b9de871ab5dade5
Source1: %{name}.init
+# https://gitorious.org/debian-pkg/minidlna/blobs/raw/master/debian/minidlna.1
+Source4: %{name}.1
+# https://gitorious.org/debian-pkg/minidlna/blobs/raw/master/debian/minidlna.conf.5
+Source5: %{name}.conf.5
Patch0: %{name}-ffmpeg10.patch
URL: http://sourceforge.net/projects/minidlna/
# libavcodec libavformat libavutil
@@ -47,7 +51,7 @@ którego celem jest pełna zgodność z klientami DLNA/UPnP-AV.
%install
rm -rf $RPM_BUILD_ROOT
-install -d $RPM_BUILD_ROOT/etc/rc.d/init.d
+install -d $RPM_BUILD_ROOT{/etc/rc.d/init.d,%{_mandir}/man{1,5}}
%{__make} -j1 install \
DESTDIR=$RPM_BUILD_ROOT
@@ -57,6 +61,10 @@ install -d $RPM_BUILD_ROOT/etc/rc.d/init.d
install %{SOURCE1} $RPM_BUILD_ROOT/etc/rc.d/init.d/%{name}
+# Install man pages
+install %{SOURCE4} $RPM_BUILD_ROOT%{_mandir}/man1/
+install %{SOURCE5} $RPM_BUILD_ROOT%{_mandir}/man5/
+
for f in po/*.po ; do
lang=$(basename $f .po)
install -d $RPM_BUILD_ROOT%{_localedir}/${lang}/LC_MESSAGES
@@ -84,3 +92,5 @@ rm -rf $RPM_BUILD_ROOT
%attr(754,root,root) /etc/rc.d/init.d/minidlna
%attr(640,root,root) %config(noreplace) %verify(not md5 mtime size) %{_sysconfdir}/minidlna.conf
%attr(755,root,root) %{_sbindir}/minidlna
+%{_mandir}/man1/*
+%{_mandir}/man5/*
diff --git a/minidlna.1 b/minidlna.1
new file mode 100644
index 0000000..ccf2f7a
--- /dev/null
+++ b/minidlna.1
@@ -0,0 +1,111 @@
+.\" Man page for minidlna
+.\"
+.\" Copyright (C) 2010-2011 Benoît Knecht <benoit.knecht at 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
diff --git a/minidlna.conf.5 b/minidlna.conf.5
new file mode 100644
index 0000000..605111e
--- /dev/null
+++ b/minidlna.conf.5
@@ -0,0 +1,269 @@
+.\" 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 at users.sourceforge.net>
+.\" Copyright (C) 2010-2011 Benoît Knecht <benoit.knecht at 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 July 21, 2012
+.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 / .
+This option can be specified more than once.
+.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
+.Dq yes
+to enable support for streaming JPEG and mp3 files to a TiVo supporting HMO.
+Set to
+.Dq no
+otherwise.
+.It Cm friendly_name
+Customize the name that the
+.Nm minidlna
+server sends to clients. Defaults to
+.Dq hostname:\ username .
+.It Cm inotify
+Set to
+.Dq yes
+to enable inotify monitoring of the files under
+.Cm media_dir
+to automatically discover new files. Set to
+.Dq no
+to disable inotify.
+.It Cm listening_ip
+IPv4 address
+.Nm minidlna
+should listen on
+.Pq e.g. Dq 198.51.100.1/24 .
+If omitted, the mask defaults to /24. This option can be specified more than
+once. If unspecified or empty,
+.Nm minidlna
+binds to the network interfaces given in
+.Cm network_interface ;
+if it is also unspecified or empty, it binds to all the valid network
+interfaces
+.Pq except loopback .
+.It Cm log_dir
+Path to the directory where the log file should be stored. Defaults to
+.Pa /var/log .
+.It Cm log_level
+Defines the type of messages that should be logged, and down to which level of
+importance they should be considered.
+.Pp
+The possible types are
+.Dq artwork ,
+.Dq database ,
+.Dq general ,
+.Dq http ,
+.Dq inotify ,
+.Dq metadata ,
+.Dq scanner ,
+.Dq ssdp
+and
+.Dq tivo .
+.Pp
+The levels are
+.Dq off ,
+.Dq fatal ,
+.Dq error ,
+.Dq warn ,
+.Dq info
+and
+.Dq debug ,
+listed here in order of decreasing importance.
+.Dq off
+turns off logging messages entirely,
+.Dq fatal
+logs the most critical messages only, and so on down to
+.Dq debug
+that logs every single messages.
+.Pp
+The types are comma-separated, followed by an equal sign
+.Pq Ql = ,
+followed by a level that applies to the preceding types. This can be repeated,
+separating each of these constructs with a comma.
+.Pp
+Defaults to
+.Dq general,\:artwork,\:database,\:inotify,\:scanner,\:metadata,\:http,\:\
+ssdp,\:tivo=warn
+which logs every type of message at the
+.Dq warn
+level.
+.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 .
+.Pp
+After making changes to this option, you need to rebuild the database.
+If you use an init script to start/stop
+.Nm minidlna,
+then you should run
+.Pq as root
+.Ic service
+.Cm minidlna
+.Cm force-reload .
+Otherwise, just add
+.Fl R
+to your usual
+.Nm minidlna
+command line
+.Po
+.Ic minidlna
+.Op ...
+.Fl R
+.Pc .
+.It Cm minissdpdsocket
+Path to the MiniSSDPd socket, if you want to use
+.Nm minidlna
+together with MiniSSDPd. Defaults to
+.Pa /run/minissdpd.sock .
+.It Cm model_name
+Set the model name reported to clients.
+Defaults to
+.Dq Windows Media Connect compatible (MiniDLNA) .
+.It Cm model_number
+Set the model number reported to clients. Defaults to the version number of
+.Nm minidlna .
+.It Cm network_interface
+Network interface(s) to bind to
+.Pq e.g. eth0 ,
+comma delimited. This option can be specified more than once. If unspecified or empty,
+.Nm minidlna
+binds to the IPs given in
+.Cm listening_ip ;
+if it is also unspecified or empty, it binds to all the valid network
+interfaces
+.Pq except loopback .
+.It Cm notify_interval
+Set the notify interval, in seconds. The default is 895 seconds.
+.It Cm port
+Port number for HTTP traffic
+.Pq descriptions, SOAP, media transfe .
+This option is mandatory, unless the port number is specified on the
+command-line using
+.Fl p Pq see Xr minidlna 1 .
+.It Cm presentation_url
+Define the URL presented to clients
+.Pq e.g. Dq http://example.com:80 .
+The default is
+.Ql / .
+.It Cm root_container
+Use a different container as the root of the tree exposed to clients. The
+possible values
+.Bl -bullet -offset indent -compact
+.It
+.Ql \&.
+to use the standard container (this is the default);
+.It
+.Ql B
+to use the
+.Dq Browse Directory
+container;
+.It
+.Ql M
+to use the
+.Dq Music
+container;
+.It
+.Ql V
+to use the
+.Dq Video
+container;
+.It
+.Ql P
+to use the
+.Dq Pictures
+container.
+.El
+If you specify
+.Ql B
+and the client device is audio only, then
+.Dq Music/Folders
+will be used as the root container.
+.It Cm serial
+Set the serial number reported to clients. Defaults to
+.Dq 00000000 .
+.It Cm strict_dlna
+Set to
+.Dq 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
+.Dq 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
================================================================
---- gitweb:
http://git.pld-linux.org/gitweb.cgi/packages/minidlna.git/commitdiff/8b8001ed8f19aa709734642505de888ad5e653ba
More information about the pld-cvs-commit
mailing list