~ubuntu-branches/ubuntu/trusty/xmms2/trusty-proposed

« back to all changes in this revision

Viewing changes to src/clients/launcher/xmms2-launcher.1

  • Committer: Bazaar Package Importer
  • Author(s): Benjamin Drung
  • Date: 2011-10-22 23:53:00 UTC
  • mfrom: (1.1.9 upstream)
  • Revision ID: james.westby@ubuntu.com-20111022235300-xnuousf7u2622uph
Tags: 0.8+dfsg-1
* New upstream release.
  - Drop code name DrO_o from Debian version, because an underscore is not
    allowed in a Debian version.
  - Order items alphabetically in xmms2 manual page (Closes: #620665).
* Drop backported patches and patches that are applied upstream.
* Refresh remaining four patches.
* Drop xmms2-client-vis, because its content is not meant for anything other
  than development reference.
* Drop xmms2-et package, because it used only in the test phase.
* Add new xmms2-plugin-sndfile package.
  - Add libsndfile1-dev as build dependency for it.
* libxmmsclient6.symbols: Add new and remove five symbols that were only
  internal symbols.
* Update watch file.
* Replace Florian Ragwitz as maintainer. Thanks for your work.
* Remove all inactive uploaders. Thanks to them for their previous work.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.\" 
 
1
.\"
2
2
.\" XMMS2 - The next generation of the XMMS music player.
3
3
.\"
4
4
.\" xmms2-launcher.1 - xmms2-launcher man page
5
5
.\"
6
 
.\" Copyright (C) 2005-2009 XMMS2 Team
 
6
.\" Copyright (C) 2005-2011 XMMS2 Team
7
7
.\"
8
8
.\" Redistribution and use in source and binary forms, with or without
9
9
.\" modification, are permitted provided that the following conditions
16
16
.\"    documentation and/or other materials provided with the distribution.
17
17
.\" 3. The name of the author may not be used to endorse or promote products
18
18
.\"    derived from this software without specific prior written permission
19
 
.\" 
 
19
.\"
20
20
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21
21
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22
22
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
27
27
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28
28
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29
29
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
 
.\" 
 
30
.\"
31
31
.TH XMMS2-LAUNCHER 1
32
32
.SH NAME
33
33
xmms2-launcher \- XMMS2 daemon launcher
34
34
.SH SYNOPSIS
35
 
.P
36
 
.I xmms2-launcher
37
 
[
38
 
.B -?
39
 
40
 
.B --help
41
 
]
42
 
.P
43
 
.I xmms2-launcher
44
 
[
45
 
.B -l 
46
 
logfile / 
47
 
.B --logfile=
48
 
logfile]
49
 
[
50
 
.B -P 
51
 
pidfile / 
52
 
.B --pidfile=
53
 
pidfile]
54
 
[
55
 
.B --verbose
56
 
]
 
35
.B xmms2-launcher
 
36
.RB [\| -l
 
37
.IR file \|]
 
38
.RB [\| -P
 
39
.IR file \|]
 
40
.RB [\| -v \|]
 
41
.RB [\| -- \|]
 
42
.RI [\| XMMS2D_OPTION \|]
 
43
\|...
 
44
.br
 
45
.B xmms2-launcher -h
57
46
.SH DESCRIPTION
58
 
 
59
 
.B XMMS2
60
 
is a redesign of the XMMS (http://www.xmms.org) music player. It features a client-server model, allowing multiple (even simultaneous!) user interfaces, both textual and graphical. All common audio formats are supported using plugins. On top of this, there is a flexible media library to organise your music.
 
47
XMMS2 is a redesign of the XMMS (http://legacy.xmms2.org) music player. It features a client-server model, allowing multiple (even simultaneous!) user interfaces, both textual and graphical. All common audio formats are supported using plugins. On top of this, there is a flexible media library to organise your music.
61
48
.PP
62
 
 
63
 
.I xmms2-launcher
64
 
starts 
65
 
.I xmms2d(1)
66
 
in the background. The main feature is that it does not exit until the IPC system of 
67
 
.B XMMS2
68
 
is available, meaning that as soon as the 
69
 
.I xmms2-launcher
70
 
process has exited successfully 
71
 
.I xmms2d(1)
 
49
.B xmms2-launcher
 
50
starts
 
51
.BR xmms2d (1)
 
52
in the background. The main feature is that it does not exit until the IPC system of XMMS2 is available, meaning that as soon as the
 
53
.B xmms2-launcher
 
54
process has exited successfully
 
55
.BR xmms2d (1)
72
56
is ready to accept commands.
73
 
.PP
74
 
.I xmms2-launcher
75
 
includes command line options to change the way in which the daemon is invoked.
76
 
.TP
77
 
.BR
78
 
These options are currently recognised:
79
 
.TP
80
 
.I
81
 
\-l logfile / \-\-logfile=logfile
82
 
Write log file to 
83
 
.I logfile
84
 
instead of the default log file location
85
 
.TP
86
 
.I
87
 
\- P pidfile / \-\-pidfile=pidfile
88
 
Write the pid of 
89
 
.I xmms2d
90
 
to the file specified by 
91
 
.I pidfile
92
 
.TP
93
 
.I
94
 
\-\-verbose
95
 
Increases the vebosity of
96
 
.I xmms2-launcher
97
 
.TP
98
 
.I
99
 
\-? / \-\-help
100
 
Show help options
 
57
.SH OPTIONS
 
58
Unrecognized options and options occuring beyond pseudo-option
 
59
.B --
 
60
are passed to
 
61
.BR xmms2d (1).
 
62
.TP
 
63
.BI \-l\  file ,\ \-\-logfile= file
 
64
Write log to
 
65
.I file
 
66
instead of the default log file location.
 
67
.TP
 
68
.BI \-P\  file ,\ \-\-pidfile= file
 
69
Write the pid of
 
70
.BR xmms2d (1)
 
71
to
 
72
.IR file .
 
73
.TP
 
74
.B \-v, \-\-verbose
 
75
Make xmms2-launcher verbose.
 
76
.TP
 
77
.B \-?, \-h, \-\-help
 
78
Show short help information and exit.
 
79
.TP
 
80
.B --
 
81
Options beyond this marker are passed to
 
82
.BR xmms2d (1).
 
83
.TP
 
84
.I XMMS2D_OPTION
 
85
See
 
86
.BR xmms2d (1)
 
87
for a list of options and their effect.
101
88
.SH FILES
102
 
.TP
103
 
.I $XDG_CACHE_HOME/xmms2/xmms2d.log
104
 
The default location for a file where the log output of 
105
 
.I xmms2d(1)
106
 
is redirected. Usually ~/.cache/xmms2/xmms2d.log.
 
89
Below
 
90
.I CACHEDIR
 
91
is
 
92
.I $XDG_CACHE_HOME/xmms2
 
93
on UNIX if the
 
94
.BR XDG_CACHE_HOME -environment
 
95
variable is set. Otherwise it is
 
96
.I $HOME/.cache/xmms2
 
97
(UNIX except Darwin), or
 
98
.I $HOME/Library/xmms2/logs
 
99
(Darwin).
 
100
.TP
 
101
.I CACHEDIR/xmms2d.log
 
102
The default location for storing log output of
 
103
.BR xmms2d (1).
 
104
.SH ENVIRONMENT
 
105
.TP
 
106
.B XDG_CACHE_HOME
 
107
The location where the XMMS2 logs are located by default.
107
108
.SH SEE ALSO
108
 
xmms2d(1), http://xmms2.xmms.org
 
109
.BR xmms2d (1),\  http://xmms2.org/ .
109
110
.SH HISTORY
110
 
The 
111
 
.B XMMS2
112
 
Project was started by Tobias Rundstr�m and Anders Gustafsson. It is developed with their lead by a small group of contributers from all over the world.
 
111
The XMMS2 Project was started by Tobias Rundstr�m and Anders Waldenborg. It is developed by a small group of contributers from all over the world.
113
112
.SH AUTHOR
114
 
This manual page was written by Alexander Botero-Lowry <alex@foxybanana.com>
 
113
This manual page was written by Alexander Botero-Lowry <alex@foxybanana.com>. It was reformatted by Erik Massop <e.massop@hccnet.nl>.