X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=web%2Fmanual.m4;h=1fd0ed1972378554bc9c277ddd9c6e0b70f7c5c0;hb=b2e4347baf722d13e4936cf2138750f05c43c3da;hp=d0fe28e0ac6fed4e67db6dd0d0cef8a6784e7940;hpb=837cd1ab890645d9fd7d0d85139fdf076d987ea4;p=paraslash.git diff --git a/web/manual.m4 b/web/manual.m4 index d0fe28e0..1fd0ed19 100644 --- a/web/manual.m4 +++ b/web/manual.m4 @@ -208,7 +208,7 @@ For the impatient: cd osl && make && sudo make install && sudo ldconfig sudo apt-get install autoconf libssl-dev help2man gengetopt \ libmad0-dev libid3tag0-dev libasound2-dev libvorbis-dev \ - libfaad-dev libspeex-dev libFLAC-dev libsamplerate-dev \ + libfaad-dev libspeex-dev libFLAC-dev libsamplerate-dev realpath \ libasound2-dev libao-dev libreadline-dev libncurses-dev \ libopus-dev @@ -222,7 +222,7 @@ Detailed description: In any case you'll need - XREFERENCE(ftp://ftp.gnu.org/pub/gnu/gcc, gcc) or XREFERENCE(http://clang.llvm.org, clang). All gcc versions - >= 3.3 are currently supported. Clang version 1.1 or newer + >= 4.2 are currently supported. Clang version 1.1 or newer should work as well. - XREFERENCE(ftp://ftp.gnu.org/pub/gnu/make, gnu make) is @@ -259,7 +259,8 @@ Optional: - XREFERENCE(http://www.underbit.com/products/mad/, libid3tag). For version-2 ID3 tag support, you'll need the libid3tag development package libid3tag0-dev. Without - libid3tag, only version one tags are recognized. + libid3tag, only version-1 tags are recognized. The mp3 tagger + also needs this library for modifying (id3v1 and id3v2) tags. - XREFERENCE(http://www.xiph.org/downloads/, ogg vorbis). For ogg vorbis streams you'll need libogg, libvorbis, @@ -751,7 +752,7 @@ is applied to all audio files matching this pattern: The command - para_client -- ls -lv + para_client -- ls -l=v gives you a verbose listing of your audio files also showing which attributes are set. @@ -955,12 +956,13 @@ is not set, the empty string is matched against the pattern. frequency ~ channels ~ num_played ~ + image_id ~ + lyrics_id ~ Takes a comparator ~ of the set {<, =, <=, >, >=, !=} and a number . Matches an audio file iff the condition ~ is satisfied where val is the corresponding value of the audio file -(value of the year tag, bitrate in kbit/s, frequency in Hz, channel -count, play count). +(value of the year tag, bitrate in kbit/s, etc.). The year tag is special as its value is undefined if the audio file has no year tag or the content of the year tag is not a number. Such @@ -2009,21 +2011,19 @@ Doxygen ~~~~~~~ Doxygen is a documentation system for various programming -languages. The paraslash project uses Doxygen for generating the API -reference on the web pages, but good source code documentation is -also beneficial to people trying to understand the code structure -and the interactions between the various source files. +languages. The API reference on the paraslash web page is generated +by doxygen. It is more illustrative to look at the source code for examples than -to describe the conventions for documenting the source in this manual, -so we only describe which parts of the code need doxygen comments, -but leave out details on documentation conventions. +to describe the conventions in this manual, so we only describe which +parts of the code need doxygen comments, but leave out details on +documentation conventions. As a rule, only the public part of the C source is documented with Doxygen. This includes structures, defines and enumerations in header files as well as public (non-static) C functions. These should be -documented completely. For example each parameter and the return -value of a public function should get a descriptive comment. +documented completely. For example, each parameter and the return +value of a public function should get a descriptive doxygen comment. No doxygen comments are necessary for static functions and for structures and enumerations in C files (which are used only within @@ -2214,7 +2214,6 @@ Application web pages ~~~~~~~~~~~~~~~~~~~~~ - XREFERENCE(http://people.tuebingen.mpg.de/maan/paraslash/, paraslash) - - XREFERENCE(http://paraslash.systemlinux.org/, paraslash (alternative page)) - XREFERENCE(http://xmms2.org/wiki/Main_Page, xmms) - XREFERENCE(http://www.mpg123.de/, mpg123) - XREFERENCE(http://gstreamer.freedesktop.org/, gstreamer)