annotate audacious.1.in @ 402:f8c4adf662a4 trunk

[svn] trivial manpage fix (spotted by dai)
author nenolod
date Sun, 08 Jan 2006 01:33:29 -0800
parents cb178e5ad177
children e829f55336ab
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
402
f8c4adf662a4 [svn] trivial manpage fix (spotted by dai)
nenolod
parents: 0
diff changeset
1 .TH AUDACIOUS "1" "24 October 2005" "Version @VERSION@" "Audacious Manual Pages"
0
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
2 .SH NAME
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
3 Audacious \- an audio player for X.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
4 .SH SYNOPSIS
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
5 .B audacious
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
6 [\-h] [\-\-help] [\-n \fI<session>\fP] [\-\-session=\fI<session>\fP] [\-r]
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
7 [\-\-rew] [\-p] [\-\-play] [\-u] [\-\-pause] [\-s] [\-\-stop] [\-f]
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
8 [\-\-fwd] [\-e] [\-\-enqueue] [\-m] [\-\-show\-main\-window] [\-v]
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
9 [\-\-version] [\fIfilename\fP]...
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
10 .SH DESCRIPTION
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
11 \fIAudacious\fP is a media player, based on Beep Media Player,
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
12 which is in turn based on the X Multimedia System.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
13 It is used to play audio and other kinds of media files. By default
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
14 Audacious can play MPEG audio, Ogg Vorbis, RIFF wav, most module formats,
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
15 and a few other formats. Audacious can be extended through plugins to play
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
16 a number of other audio and video formats.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
17 .SH OPTIONS
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
18 Audacious accepts the following options:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
19 .TP
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
20 .B \-h, \-\-help
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
21 Show summary of options.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
22 .TP
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
23 .B \-n, \-\-session
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
24 Select Audacious/BMP/XMMS session (Default: 0).
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
25 .TP
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
26 .B \-r, \-\-rew
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
27 Skip backwards in playlist.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
28 .TP
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
29 .B \-p, \-\-play
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
30 Start playing current playlist.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
31 .TP
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
32 .B \-u, \-\-pause
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
33 Pause current song.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
34 .TP
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
35 .B \-s, \-\-stop
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
36 Stop current song.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
37 .TP
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
38 .B \-t, \-\-play\-pause
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
39 Pause if playing, play otherwise.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
40 .TP
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
41 .B \-f, \-\-fwd
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
42 Skip forward in playlist.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
43 .TP
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
44 .B \-e, \-\-enqueue
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
45 Don't clear the playlist.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
46 .TP
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
47 .B \-m, \-\-show\-main\-window
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
48 Show the main window.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
49 .TP
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
50 .B \-v, \-\-version
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
51 Print version number and exit.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
52 .SH SKINS
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
53 Audacious supports Winamp Classic style skins. Skins may be stored in either
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
54 archived (\fI.zip\fP, \fI.wsz\fP, \fI.tgz\fP, \fI.tar.gz\fP,
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
55 or \fI.tar.bz2\fP) or unarchived format. Audacious looks for skinfiles in
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
56 @datadir@/audacious/Skins, ~/.audacious/Skins, and locations specified by the
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
57 \fBSKINSDIR\fP variable.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
58 .SH KEYBINDINGS
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
59 Global keybindings for Audacious:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
60
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
61 .in +2
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
62 .ta \w'Shift + Control + w 'u
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
63 z Previous song
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
64 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
65 x Play
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
66 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
67 c Pause
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
68 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
69 v Stop
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
70 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
71 b Next song
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
72 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
73 l Play file
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
74 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
75 j Jump to file
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
76 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
77 r Toggle Repeat
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
78 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
79 s Toggle Shuffle
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
80 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
81 Shift + l Play directory
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
82 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
83 Control + l Play location
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
84 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
85 Control + p Preferences dialog
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
86 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
87 Control + v Visualization plugin dialog
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
88 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
89 Control + r Time remaining
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
90 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
91 Control + a Always on top
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
92 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
93 Control + w Winshade mode
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
94 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
95 Control + d Doublesize mode
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
96 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
97 Control + e Easy move
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
98 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
99 Control + j Jump to time
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
100 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
101 Control + z Start of list
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
102 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
103 Control + n No Playlist Advance
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
104 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
105 Control + 3 File info dialog
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
106 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
107 Control + Alt + w Toggle Equalizer winshade mode
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
108 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
109 Shift + Control + w Playlist winshade mode
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
110 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
111 Alt + w Hide/show mainwindow
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
112 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
113 Alt + e Hide/show playlistwindow
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
114 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
115 Alt + g Hide/show Equalizer
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
116 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
117 Alt + s Skin selecting window
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
118 .in -2
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
119
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
120 Main window specific:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
121
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
122 .in +2
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
123 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
124 Arrow key up Volume up 2%
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
125 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
126 Arrow key down Volume down 2%
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
127 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
128 Arrow key right Skip 5 seconds forward in song
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
129 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
130 Arrow key left Skip 5 seconds back in song
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
131 .in -2
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
132
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
133 Playlist window specific:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
134
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
135 .in +2
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
136 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
137 Arrow key up Up one step in playlist
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
138 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
139 Arrow key down Down one step in playlist
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
140 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
141 Delete Remove selected songs from playlist
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
142 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
143 Page Up Move one page up
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
144 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
145 Page Down Move one page down
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
146 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
147 Home First page in playlist
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
148 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
149 End Last page in playlist
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
150 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
151 Enter Play selected song
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
152 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
153 Insert Add file dialog
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
154 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
155 Shift + Insert Add directory dialog
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
156 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
157 Alt + Insert Add url dialog
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
158 .in -2
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
159
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
160 Equalizer shade mode specific:
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
161
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
162 .in +2
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
163 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
164 Arrow key up Volume up 2%
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
165 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
166 Arrow key down Volume down 2%
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
167 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
168 Arrow key right Balance 4% to right
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
169 .br
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
170 Arrow key left Balance 4% to left
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
171 .in -2
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
172 .SH FILES
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
173 .TP \w'~/.audacious/playlist.m3uXX'u
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
174 ~/.audacious/config
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
175 Users' Audacious configuration.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
176 .TP
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
177 ~/.audacious/playlist.m3u
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
178 Default playlist usually loaded on startup.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
179 .TP
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
180 ~/.audacious/gtkrc
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
181 Users set of Audacious-specific GTK config settings. Options such as widget
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
182 color and fonts sizes can be set here.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
183 .TP
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
184 ~/.audacious/menurc
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
185 Users set of keybindings.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
186 .TP
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
187 ~/.audacious/Skins, @datadir@/audacious/Skins
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
188 Default locations where Audacious should look for skinfiles.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
189 .TP
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
190 ~/.audacious/Plugins
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
191 Location of user installed plugins.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
192 .SH ENVIRONMENT
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
193 .TP 12
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
194 .B SKINSDIR
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
195 Colon separated list of paths where Audacious should look for skinfiles.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
196 .TP
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
197 .B TARCMD
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
198 Tar command supporting GNU tar style decompression. Used for
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
199 unpacking gzip and bzip2 compressed skins. Default is \fItar\fP.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
200 .TP
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
201 .B UNZIPCMD
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
202 Command for decompressing zip files (skins). Default is \fIunzip\fP.
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
203 .SH OTHER INFO
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
204 The webpage for Audacious is at http://audacious.nenolod.net. Here you can find
cb178e5ad177 [svn] Import audacious source.
nenolod
parents:
diff changeset
205 info about Audacious, download the latest version, plugins, and skins.