Skip to content

Commit

Permalink
Readd manpage to master
Browse files Browse the repository at this point in the history
  • Loading branch information
masmu committed Mar 9, 2016
1 parent f351ff9 commit 96a2b4e
Show file tree
Hide file tree
Showing 4 changed files with 193 additions and 6 deletions.
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ release: manpage
lintian --pedantic dist/*.deb dist/*.dsc dist/*.changes
sudo chown -R $(user) dist/

manpage: debian/pulseaudio-dlna.1
manpage: man/pulseaudio-dlna.1

debian/pulseaudio-dlna.1: pulseaudio_dlna.egg-info
man/pulseaudio-dlna.1: pulseaudio_dlna.egg-info
export USE_PKG_VERSION=1; help2man -n "Stream audio to DLNA devices and Chromecasts" "bin/pulseaudio-dlna" > /tmp/pulseaudio-dlna.1
mv /tmp/pulseaudio-dlna.1 debian/pulseaudio-dlna.1
mv /tmp/pulseaudio-dlna.1 man/pulseaudio-dlna.1

clean:
rm -rf build dist $(shell find pulseaudio_dlna -name "__pycache__")
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ If I could help you or if you like my work, you can buy me a [coffee, a beer or

## Changelog ##

* __0.5.0__ - (_2016-03-09_)
* __0.5.0.x__ - (_2016-03-09_)
- Set Yamaha devices to the appropriate mode before playing (thanks to [hlchau](https://github.com/hlchau)) (new dependency: `python-lxml`)
- Fixed a bug where some SSDP messages could not get parsed correctly
- Also support media renderers identifying as `urn:schemas-upnp-org:device:MediaRenderer:2`
Expand Down
187 changes: 187 additions & 0 deletions man/pulseaudio-dlna.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,187 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.2.
.TH PULSEAUDIO-DLNA "1" "March 2016" "pulseaudio-dlna 0.5.0.1" "User Commands"
.SH NAME
pulseaudio-dlna \- Stream audio to DLNA devices and Chromecasts
.SH DESCRIPTION
.SS "Usage:"
.TP
pulseaudio\-dlna pulseaudio\-dlna [\-\-host <host>] [\-\-port <port>][\-\-encoder <encoders> | \fB\-\-codec\fR <codec>] [\-\-bit\-rate=<rate>]
[\-\-encoder\-backend <encoder\-backend>]
[\-\-filter\-device=<filter\-device>]
[\-\-renderer\-urls <urls>]
[\-\-request\-timeout <timeout>]
[\-\-msearch\-port=<msearch\-port>] [\-\-ssdp\-mx <ssdp\-mx>] [\-\-ssdp\-ttl <ssdp\-ttl>] [\-\-ssdp\-amount <ssdp\-amount>]
[\-\-cover\-mode <mode>]
[\-\-auto\-reconnect]
[\-\-debug]
[\-\-fake\-http10\-content\-length] [\-\-fake\-http\-content\-length]
[\-\-disable\-switchback] [\-\-disable\-ssdp\-listener] [\-\-disable\-device\-stop] [\-\-disable\-workarounds]
.TP
pulseaudio\-dlna [\-\-host <host>] [\-\-create\-device\-config] [\-\-update\-device\-config]
[\-\-msearch\-port=<msearch\-port>] [\-\-ssdp\-mx <ssdp\-mx>] [\-\-ssdp\-ttl <ssdp\-ttl>] [\-\-ssdp\-amount <ssdp\-amount>]
.IP
pulseaudio\-dlna [\-h | \fB\-\-help\fR | \fB\-\-version]\fR
.SH OPTIONS
.TP
\fB\-\-create\-device\-config\fR
Discovers all devices in your network and write a config for them.
That config can be editied manually to adjust various settings.
You can set:
.TP
\- Device name
\- Codec order (The first one is used if the encoder binary is available on your system)
\- Various codec settings such as the mime type, specific rules or
.TP
the bit rate (depends on the codec)
A written config is loaded by default if the \fB\-\-encoder\fR and \fB\-\-bit\-rate\fR options are not used.
.TP
\fB\-\-update\-device\-config\fR
Same as \fB\-\-create\-device\-config\fR but preserves your existing config from being overwritten
.TP
\fB\-\-host=\fR<host>
Set the server ip.
.TP
\fB\-p\fR \fB\-\-port=\fR<port>
Set the server port [default: 8080].
.TP
\fB\-e\fR \fB\-\-encoder=\fR<encoders>
Deprecated alias for \fB\-\-codec\fR
.TP
\fB\-c\fR \fB\-\-codec=\fR<codecs>
Set the audio codec.
Possible codecs are:
.TP
\- mp3
MPEG Audio Layer III (MP3)
.TP
\- ogg
Ogg Vorbis (OGG)
.TP
\- flac
Free Lossless Audio Codec (FLAC)
.TP
\- wav
Waveform Audio File Format (WAV)
.TP
\- opus
Opus Interactive Audio Codec (OPUS)
.TP
\- aac
Advanced Audio Coding (AAC)
.TP
\- l16
Linear PCM (L16)
.TP
\fB\-\-encoder\-backend=\fR<encoder\-backend>
Set the backend for all encoders.
Possible backends are:
.TP
\- generic (default)
\- ffmpeg
\- avconv
.TP
\fB\-b\fR \fB\-\-bit\-rate=\fR<rate>
Set the audio encoder's bitrate.
.TP
\fB\-\-filter\-device=\fR<filter\-device>
Set a name filter for devices which should be added.
Devices which get discovered, but won't match the
filter text will be skipped.
.TP
\fB\-\-renderer\-urls=\fR<urls>
Set the renderer urls yourself. no discovery will commence.
.TP
\fB\-\-request\-timeout=\fR<timeout>
Set the timeout for requests in seconds [default: 15].
.TP
\fB\-\-ssdp\-ttl=\fR<ssdp\-ttl>
Set the SSDP socket's TTL [default: 10].
.TP
\fB\-\-ssdp\-mx=\fR<ssdp\-mx>
Set the MX value of the SSDP discovery message [default: 3].
.TP
\fB\-\-ssdp\-amount=\fR<ssdp\-amount>
Set the amount of SSDP discovery messages being sent [default: 5].
.TP
\fB\-\-msearch\-port=\fR<msearch\-port>
Set the source port of the MSEARCH socket [default: random].
.TP
\fB\-\-cover\-mode=\fR<mode>
Set the cover mode [default: default].
Possible modes are:
.TP
\- disabled
No icon is shown
.TP
\- default
The application icon is shown
.TP
\- distribution
The icon of your distribution is shown
.TP
\- application
The audio application's icon is shown
.TP
\fB\-\-debug\fR
enables detailed debug messages.
.TP
\fB\-\-auto\-reconnect\fR
If set, the application tries to reconnect devices in case the stream collapsed
.TP
\fB\-\-fake\-http\-content\-length\fR
If set, the content\-length of HTTP requests will be set to 100 GB.
.TP
\fB\-\-disable\-switchback\fR
If set, streams won't switched back to the default sink if a device disconnects.
.TP
\fB\-\-disable\-ssdp\-listener\fR
If set, the application won't bind to the port 1900 and therefore the automatic discovery of new devices won't work.
.TP
\fB\-\-disable\-device\-stop\fR
If set, the application won't send any stop commands to renderers at all
.TP
\fB\-\-disable\-workarounds\fR
If set, the application won't apply any device workarounds
.TP
\fB\-v\fR \fB\-\-version\fR
Show the version.
.TP
\fB\-h\fR \fB\-\-help\fR
Show the help.
.SH EXAMPLES
.IP
\- pulseaudio\-dlna
.IP
will start pulseaudio\-dlna on port 8080 and stream your PulseAudio streams encoded with mp3.
.IP
\- pulseaudio\-dlna \-\-encoder ogg
.IP
will start pulseaudio\-dlna on port 8080 and stream your PulseAudio streams encoded with Ogg Vorbis.
.IP
\- pulseaudio\-dlna \-\-port 10291 \-\-encoder flac
.IP
will start pulseaudio\-dlna on port 10291 and stream your PulseAudio streams encoded with FLAC.
.IP
\- pulseaudio\-dlna \-\-filter\-device 'Nexus 5,TV'
.IP
will just use devices named Nexus 5 or TV even when more devices got discovered.
.IP
\- pulseaudio\-dlna \-\-renderer\-urls http://192.168.1.7:7676/smp_10_
.IP
won't discover upnp devices by itself. Instead it will search for upnp renderers
at the specified locations. You can specify multiple locations via urls
separated by comma (,). Most users won't ever need this option, but since
UDP multicast packages won't work (most times) over VPN connections this is
very useful if you ever plan to stream to a UPNP device over VPN.
.SH "SEE ALSO"
The full documentation for
.B pulseaudio-dlna
is maintained as a Texinfo manual. If the
.B info
and
.B pulseaudio-dlna
programs are properly installed at your site, the command
.IP
.B info pulseaudio-dlna
.PP
should give you access to the complete manual.
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"Topic :: Multimedia :: Sound/Audio",
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
],
version='0.5.0',
version='0.5.0.1',
py_modules=[],
packages=setuptools.find_packages(),
install_requires=[
Expand All @@ -56,7 +56,7 @@
]
},
data_files=[
("share/man/man1", ["debian/pulseaudio-dlna.1"]),
("share/man/man1", ["man/pulseaudio-dlna.1"]),
],
package_data={
"pulseaudio_dlna.plugins.upnp": ["xml/*.xml"],
Expand Down

0 comments on commit 96a2b4e

Please sign in to comment.