diff --git a/doc/aqualung.1 b/doc/aqualung.1 index aca4f99e..a91283e7 100644 --- a/doc/aqualung.1 +++ b/doc/aqualung.1 @@ -1,4 +1,4 @@ -.TH AQUALUNG 1 "28 August 2020" +.TH AQUALUNG 1 "29 August 2020" .SH NAME aqualung \- Music player for GNU/Linux .SH SYNOPSIS @@ -11,7 +11,7 @@ aqualung [--output (jack|pulse|alsa|oss|sndio|win32)] [options] [file1 [file2 .. .SH DESCRIPTION .P Aqualung is an advanced music player originally targeted at -he GNU/Linux operating system, today also running on FreeBSD, +the GNU/Linux operating system, today also running on FreeBSD, OpenBSD and Microsoft Windows. It plays audio CDs, internet radio streams and podcasts as well as soundfiles in just about any audio format and has the feature of inserting \fBno @@ -25,7 +25,7 @@ LAME). Seamless tagging of the created files is offered as part of the process. Internet radio stations streaming Ogg Vorbis or MP3 are supported. Subscribing to RSS and Atom audio podcasts is supported: Aqualung can automatically download and add new files -o the Music Store. Optional limits for the age, size and number +to the Music Store. Optional limits for the age, size and number of downloaded files can be set. .P Almost all sample-based, uncompressed formats (e.g. WAV, @@ -34,10 +34,10 @@ Lossless Audio Codec), Ogg Vorbis, Ogg Speex, MPEG Audio (including the infamous MP3 format), MOD audio formats (MOD, S3M, XM, IT, etc.), Musepack and Monkey's Audio Codec are supported. Numerous formats and codecs are also supported via -he FFmpeg project, including AC3, AAC, WMA, WavPack and the +the FFmpeg project, including AC3, AAC, WMA, WavPack and the soundtrack of many video formats. There is also a native (non-FFmpeg) WavPack decoder. The program can play the music -hrough OSS, ALSA, sndio, PulseAudio, the JACK Audio Connection +through OSS, ALSA, sndio, PulseAudio, the JACK Audio Connection Kit, or even using the Win32 Sound API (available only under Cygwin or native Win32). Depending on the compile-time options, not all file formats and output drivers may be usable in a @@ -46,7 +46,7 @@ all the compiled-in features. .P Aqualung supports the LADSPA 1.1 plugin standard. You can use any suitable plugin to enhance the music you are listening -o. +to. .P Other features of the program are: tabbed playlist, internally working volume and balance controls (not touching the @@ -65,7 +65,7 @@ metadata support for full reference. The method of assembling the title string of a track is programmable (via a user-provided Lua function) and can include nearly any metadata item or audio file attribute. See the documentation of the -fBLua extension file\fR +\fBLua extension file\fR config setting for full reference. .P You can control any running instance of the program remotely @@ -79,7 +79,7 @@ various metadata about music on your computer (including, but not limited to, the names of artists, and the titles of records and tracks). You can (and should) organize your music into trees of Artists/Records/Tracks, thereby making life easier than with -he all-in-one Winamp/XMMS playlist. Importing file metadata +the all-in-one Winamp/XMMS playlist. Importing file metadata (ID3v1, ID3v2 tags, Ogg Xiph comments, APE metadata) into the Music Store as well as getting track names from a CDDB/FreeDB database is supported. For audio CDs, CD-Text retrieval is also @@ -220,7 +220,7 @@ Set the output sample rate. -s[], --srctype[=] .br Choose the SRC type, or print the list of available -ypes if no number given. The default is SRC type 4 (Linear +types if no number given. The default is SRC type 4 (Linear Interpolator). .TP @@ -228,18 +228,18 @@ Interpolator). .P Note that remote controlling of instances is only possible if the instance you want to send a command to is running as -he same user as you are when you issue the remote command. +the same user as you are when you issue the remote command. .TP -N, --session .br Specify the instance number to send the remote command -o. Instances are numbered on a per user basis, starting +to. Instances are numbered on a per user basis, starting with 0. Except for the zero-th instance (started first), the instance number is displayed in the title bar of the main window (e.g.: `Aqualung.3'). If you don't use this option, the following options will control the zero-th instance by default, except for -L which defaults -o the present instance (so as to be able to start playback +to the present instance (so as to be able to start playback immediately from the command line). .TP -B, --back @@ -285,17 +285,17 @@ addition to Aqualung's native (XML) playlist format, the program will load M3U and PLS playlists whenever possible. .P If you used the --session option (see above), -he files will be sent to the Aqualung instance you +the files will be sent to the Aqualung instance you specified. Otherwise a new instance will start up with the files you specified. Note that if you enabled the \fBSave and restore the Playlist on exit/startup\fR option in the -fBSettings\fR dialog, the files you specify will be +\fBSettings\fR dialog, the files you specify will be loaded \fBafter\fR the automatically loaded ones. .TP -E, --enqueue .br Enqueue added files to the Playlist instead of loading -hem (which removes the previous contents of the +them (which removes the previous contents of the Playlist). Use this if you want to keep the existing items in the Playlist. .TP @@ -342,17 +342,17 @@ relies on. $XDG_CONFIG_HOME/aqualung/ .br Directory containing user settings. $XDG_CONFIG_HOME is -he user-specific directory for application configuration +the user-specific directory for application configuration information according to the XDG Base Directory Specification. - It is most likely equivalent to ~/.config, so the following - config files (except the last one, which resides in a - system-wide location) are usually found under - $HOME/.config/aqualung/ +It is most likely equivalent to ~/.config, so the following +config files (except the last one, which resides in a +system-wide location) are usually found under +$HOME/.config/aqualung/ .br Note: earlier versions of Aqualung kept these per-user - configuration files in ~/.aqualung. This legacy setup is - recognized and silently migrated to the XDG-conformant - layout. +configuration files in ~/.aqualung. This legacy setup is +recognized and silently migrated to the XDG-conformant +layout. .TP config.xml .br @@ -366,7 +366,7 @@ List of running plugins and all their settings. playlist.xml .br Automatically saved and restored playlist (if you enable -his feature). +this feature). .TP .br @@ -406,11 +406,11 @@ Tomasz Maka Jeremy Evans .SH BUGS .P -Yes. Report them to our bugtracker at +Yes. Report them to our bugtracker at +. .SH HOMEPAGE .P -Please go to to download the latest version, -and access the Aqualung bugtracker. + .SH USER'S MANUAL .P The latest version of the User's Manual is available at the project homepage.