From 16ec57d25f13f92bd0d84317f1679fef3b98eeaa Mon Sep 17 00:00:00 2001 From: gregory guy Date: Wed, 29 Jan 2020 01:10:31 +0100 Subject: Conversion to the cmake building system based on S.Amelian's work. The embedded sqlite3 has been upgraded to 3.4.2 . Added few man pages taken from the Debian packaging system. Rework of the README and INSTALL files. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: gregory guy Signed-off-by: Slávek Banko --- doc/man/CMakeLists.txt | 6 ++ doc/man/amarok.1 | 181 ++++++++++++++++++++++++++++++++++++++ doc/man/amarok_libvisual.1 | 14 +++ doc/man/amarokapp.1 | 23 +++++ doc/man/amarokcollectionscanner.1 | 63 +++++++++++++ 5 files changed, 287 insertions(+) create mode 100644 doc/man/CMakeLists.txt create mode 100644 doc/man/amarok.1 create mode 100644 doc/man/amarok_libvisual.1 create mode 100644 doc/man/amarokapp.1 create mode 100644 doc/man/amarokcollectionscanner.1 (limited to 'doc/man') diff --git a/doc/man/CMakeLists.txt b/doc/man/CMakeLists.txt new file mode 100644 index 00000000..cf75d2d7 --- /dev/null +++ b/doc/man/CMakeLists.txt @@ -0,0 +1,6 @@ +INSTALL( + FILES ${PROJECT_NAME}.1 amarokapp.1 amarok_libvisual.1 + amarokcollectionscanner.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/amarok.1 b/doc/man/amarok.1 new file mode 100644 index 00000000..821ec48c --- /dev/null +++ b/doc/man/amarok.1 @@ -0,0 +1,181 @@ +.\" Generated by kdemangen.pl and edited by hand +.TH AMAROK 1 "Mar 2004" "Trinity Desktop Environment" "An audio player for TDE" +.SH NAME +amarok +\- An audio player for TDE +.SH SYNOPSIS +amarok [Qt-options] [TDE-options] [URL(s)] +.SH DESCRIPTION +amaroK is a multimedia player based on the soundserver-independent framework. +There are many media players around these days, true. What's missing from most +players is a user interface, that doesn't get in the way of the user. +.SH OPTIONS +.SS Generic options: +.TP +.B \-\-help +Show help about options +.TP +.B \-\-help\-qt +Show Qt specific options +.TP +.B \-\-help\-tde +Show TDE specific options +.TP +.B \-\-help\-all +Show all options +.TP +.B \-\-author +Show author information +.TP +.B \-v, \-\-version +Show version information +.TP +.B \-\-license +Show license information +.TP +.B \-\- +End of options +.SS +.SS Qt options: +.TP +.B \-\-display +Use the X-server display 'displayname'. +.TP +.B \-\-session +Restore the application for the given 'sessionId'. +.TP +.B \-\-cmap +Causes the application to install a private color +map on an 8-bit display. +.TP +.B \-\-ncols +Limits the number of colors allocated in the color +cube on an 8-bit display, if the application is +using the QApplication::ManyColor color +specification. +.TP +.B \-\-nograb +tells Qt to never grab the mouse or the keyboard. +.TP +.B \-\-dograb +running under a debugger can cause an implicit +\-\-nograb, use \-\-dograb to override. +.TP +.B \-\-sync +switches to synchronous mode for debugging. +.TP +.B \-\-fn, \-\-font +defines the application font. +.TP +.B \-\-bg, \-\-background +sets the default background color and an +application palette (light and dark shades are +calculated). +.TP +.B \-\-fg, \-\-foreground +sets the default foreground color. +.TP +.B \-\-btn, \-\-button +sets the default button color. +.TP +.B \-\-name +sets the application name. +.TP +.B \-\-title +sets the application title (caption). +.TP +.B \-\-visual TrueColor +forces the application to use a TrueColor visual on +an 8-bit display. +.TP +.B \-\-inputstyle <inputstyle> +sets XIM (X Input Method) input style. Possible +values are onthespot, overthespot, offthespot and +root. +.TP +.B \-\-im <XIM server> +set XIM server. +.TP +.B \-\-noxim +disable XIM. +.TP +.B \-\-reverse +mirrors the whole layout of widgets. +.SS +.SS TDE options: +.TP +.B \-\-caption <caption> +Use 'caption' as name in the titlebar. +.TP +.B \-\-icon <icon> +Use 'icon' as the application icon. +.TP +.B \-\-miniicon <icon> +Use 'icon' as the icon in the titlebar. +.TP +.B \-\-config <filename> +Use alternative configuration file. +.TP +.B \-\-dcopserver <server> +Use the DCOP Server specified by 'server'. +.TP +.B \-\-nocrashhandler +Disable crash handler, to get core dumps. +.TP +.B \-\-waitforwm +Waits for a WM_NET compatible windowmanager. +.TP +.B \-\-style <style> +sets the application GUI style. +.TP +.B \-\-geometry <geometry> +sets the client geometry of the main widget. +.SS +.SS Arguments: +URL(s) Files/URLs to Open +.SS +.SS Options: +.TP +.B \-r, \-\-previous +Skip backwards in playlist +.TP +.B \-p, \-\-play +Start playing current playlist +.TP +.B \-s, \-\-stop +Stop playback +.TP +.B \-\-pause +Pause playback +.TP +.B \-f, \-\-next +Skip forwards in playlist +.SS +.SS Additional options: +.TP +.B \-e, \-\-enqueue +Enqueue Files/URLs + +.SH SEE ALSO +Full user documentation is available through the TDE Help Center. You can also enter the URL +.BR help:/amarok/ +directly into konqueror or you can run +.BR "`khelpcenter help:/amarok/'" +from the command-line. +.BR +.SH AUTHORS +.nf +Christian Muehlhaeuser <chris@chris.de> +.BR +Mark Kretschmann <markey@web.de> +.BR +Max Howell <max.howell@methylblue.com> +.BR +Stanislav Karchebny <berk@upnet.ru> +.BR +Please use http://bugs.trinitydesktop.org to report bugs, do not mail the authors directly. +.BR +.SH OTHER +This manual page was written by Alejandro Exojo <suy@badopi.org> for the Debian +system (but may be used by others). +.BR diff --git a/doc/man/amarok_libvisual.1 b/doc/man/amarok_libvisual.1 new file mode 100644 index 00000000..c932b9b0 --- /dev/null +++ b/doc/man/amarok_libvisual.1 @@ -0,0 +1,14 @@ +.\" This file was generated by kdemangen.pl and edited manually by Modestas Vainius +.TH AMAROK_LIBVISUAL 1 "Feb 2008" "Amarok" "LibVisual support utility for Amarok" +.SH NAME +amarok_libvisual \- LibVisual support utility for Amarok +.SH SYNOPSIS +amarok_libvisual +.SH DESCRIPTION +This is LibVisual support helper utility for Amarok. It's used internally by Amarok +itself when needed and is not supposed to be invoked manually by user. +.SS +.SH AUTHORS +Amarok Developers +.SH OTHER +This manual page was written by Modestas Vainius <modestas@vainius.eu> for Debian. diff --git a/doc/man/amarokapp.1 b/doc/man/amarokapp.1 new file mode 100644 index 00000000..91ff8b6a --- /dev/null +++ b/doc/man/amarokapp.1 @@ -0,0 +1,23 @@ +.\" Generated by kdemangen.pl and edited by hand +.TH AMAROK 1 "Feb 2008" "Amarok" "An audio player for TDE" +.SH NAME +amarokapp +\- A direct executable for Amarok. +.SH SYNOPSIS +amarokapp [Qt-options] [TDE-options] [URL(s)] +.SH DESCRIPTION +Amarok is a multimedia player based on the soundserver-independent framework. +There are many media players around these days, true. What's missing from most +players is a user interface, that doesn't get in the way of the user. +.P +This is direct Amarok executable. The recommend way to run Amarok is using +\fBamarok(1)\fP, which is a wrapper script around \fBamarokapp\fP. However, if you're +debugging Amarok with gdb, valgrind or similar program, you will probably want to +run it against this binary directly. +.P +\fBamarokapp(1)\fP takes the same command line options and arguments as +\fBamarok(1)\fP. See its manual page for more information how to run \fBamarokapp\fP. +.SH SEE ALSO +amarok(1) +.SH OTHER +This manual page was written by Modestas Vainius <modestas@vainius.eu> for Debian. diff --git a/doc/man/amarokcollectionscanner.1 b/doc/man/amarokcollectionscanner.1 new file mode 100644 index 00000000..c67cd917 --- /dev/null +++ b/doc/man/amarokcollectionscanner.1 @@ -0,0 +1,63 @@ +.\" This file was generated by kdemangen.pl and edited manually by Modestas Vainius +.TH AMAROKCOLLECTIONSCANNER 1 "Feb 2008" "Amarok" "Collection Scanner for Amarok" +.SH NAME +amarokcollectionscanner \- Collection Scanner for Amarok +.SH SYNOPSIS +amarokcollectionscanner [Qt\-options] [TDE\-options] Folder(s) +.SH DESCRIPTION +This Amarok helper utility scans folder(s) given on the command line or +restarts previous scan if \fB\-\-restart\fP option was given and writes a +specially structured XML file to standard output with extensive information +(including tags) about audio files it was able to find. XML file schema used +by this utility is Amarok specific. +.P +You may find his utility useful if you need to retreive and/or display extended +information about collection of audio files. +.SH OPTIONS +.SS +.SS Arguments: +Folder(s) Folders to scan +.SS +.SS Options: +.TP +.B \-r, \-\-recursive +Scan folders recursively +.TP +.B \-i, \-\-incremental +Incremental Scan (modified folders only) +.TP +.B \-p, \-\-importplaylists +Import playlist +.TP +.B \-s, \-\-restart +Restart the scanner at last position, after a crash [] +.SS Generic options: +.TP +.B \-\-help +Show help about options +.TP +.B \-\-help\-qt +Show Qt specific options +.TP +.B \-\-help\-tde +Show TDE specific options +.TP +.B \-\-help\-all +Show all options +.TP +.B \-\-author +Show author information +.TP +.B \-v, \-\-version +Show version information +.TP +.B \-\-license +Show license information +.TP +.B \-\- +End of options +.SS +.SH AUTHORS +Amarok Developers +.SH OTHER +This manual page was written by Modestas Vainius <modestas@vainius.eu> for Debian. -- cgit v1.2.1