summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorgregory guy <gregory-tde@laposte.net>2020-02-25 15:05:47 +0100
committerSlávek Banko <slavek.banko@axis.cz>2020-04-10 12:47:23 +0200
commitce133b3eda6bddc2750800d1bb76cf3c5a947daf (patch)
treee0f684a1d9d2f50918124dd0c163eaa1d8aba621 /doc
parentb51e232350d31b65a8cd055693c7869f0a896193 (diff)
downloadbasket-ce133b3eda6bddc2750800d1bb76cf3c5a947daf.tar.gz
basket-ce133b3eda6bddc2750800d1bb76cf3c5a947daf.zip
Conversion to the cmake building system.
Signed-off-by: gregory guy <gregory-tde@laposte.net> Signed-off-by: Slávek Banko <slavek.banko@axis.cz> (cherry picked from commit 2578c13462d6ff5f6da401c62b24c461b3b445ca)
Diffstat (limited to 'doc')
-rw-r--r--doc/CMakeLists.txt14
-rw-r--r--doc/en/CMakeLists.txt1
-rw-r--r--doc/man/CMakeLists.txt5
-rw-r--r--doc/man/basket.1171
4 files changed, 191 insertions, 0 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
new file mode 100644
index 0000000..70d6348
--- /dev/null
+++ b/doc/CMakeLists.txt
@@ -0,0 +1,14 @@
+file( GLOB _dirs RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} * )
+string( REGEX REPLACE "[ \r\n\t]+" ";" _linguas "$ENV{LINGUAS}" )
+
+foreach( _dir ${_dirs} )
+ if( IS_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/${_dir} AND
+ EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${_dir}/CMakeLists.txt )
+ if( "${_dir}" STREQUAL "en" OR
+ "${_dir}" STREQUAL "man" OR
+ "${_linguas}" MATCHES "^;*$" OR
+ ";${_linguas};" MATCHES ";${_dir};" )
+ add_subdirectory( ${_dir} )
+ endif( )
+ endif()
+endforeach()
diff --git a/doc/en/CMakeLists.txt b/doc/en/CMakeLists.txt
new file mode 100644
index 0000000..ba3ef3e
--- /dev/null
+++ b/doc/en/CMakeLists.txt
@@ -0,0 +1 @@
+tde_create_handbook( DESTINATION ${PROJECT_NAME} )
diff --git a/doc/man/CMakeLists.txt b/doc/man/CMakeLists.txt
new file mode 100644
index 0000000..8512250
--- /dev/null
+++ b/doc/man/CMakeLists.txt
@@ -0,0 +1,5 @@
+INSTALL(
+ FILES ${PROJECT_NAME}.1
+ DESTINATION ${MAN_INSTALL_DIR}/man1
+ COMPONENT doc
+)
diff --git a/doc/man/basket.1 b/doc/man/basket.1
new file mode 100644
index 0000000..db272f0
--- /dev/null
+++ b/doc/man/basket.1
@@ -0,0 +1,171 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36.
+.TH BasKet "1" "February 2007" "BasKet 1.0"
+.SH NAME
+BasKet
+.SH SYNOPSIS
+.B basket
+[\fIQt-options\fR] [\fITDE-options\fR] [\fIoptions\fR] [\fIfile\fR]
+.SH DESCRIPTION
+BasKet is a application to allow you to quickly take notes, save your ideas and assist in quickly find them later.
+Organizing your notes has never been so easy.
+Basket also allows integration with Kontact and rest of TDE environment.
+
+.SH OPTIONS
+.SS "BasKet options:"
+.TP
+\fB\-d\fR, \fB\-\-debug\fR
+Show the debug window
+.HP
+\fB\-f\fR, \fB\-\-data\-folder\fR <folder> Custom folder where to load and save basket data and application data (useful for debugging purpose)
+.TP
+\fB\-h\fR, \fB\-\-start\-hidden\fR
+Hide the main window in the system tray icon on startup
+.TP
+\fB\-k\fR, \fB\-\-use\-drkonquy\fR
+When crashing, use the standard TDE report dialog instead of sending an email
+.SS "Arguments:"
+.TP
+file
+Open basket archive or template
+.SS "Generic options:"
+.TP
+\fB\-\-help\fR
+Show help about options
+.TP
+\fB\-\-help\-qt\fR
+Show Qt specific options
+.TP
+\fB\-\-help\-tde\fR
+Show TDE specific options
+.TP
+\fB\-\-help\-all\fR
+Show all options
+.TP
+\fB\-\-author\fR
+Show author information
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+Show version information
+.TP
+\fB\-\-license\fR
+Show license information
+.TP
+\fB\-\-\fR
+End of options
+.SS "Qt options:"
+.TP
+\fB\-\-display\fR <displayname>
+Use the X\-server display 'displayname'
+.TP
+\fB\-\-session\fR <sessionId>
+Restore the application for the given 'sessionId'
+.TP
+\fB\-\-cmap\fR
+Causes the application to install a private color
+map on an 8\-bit display
+.TP
+\fB\-\-ncols\fR <count>
+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
+\fB\-\-nograb\fR
+tells Qt to never grab the mouse or the keyboard
+.TP
+\fB\-\-dograb\fR
+running under a debugger can cause an implicit
+\fB\-nograb\fR, use \fB\-dograb\fR to override
+.TP
+\fB\-\-sync\fR
+switches to synchronous mode for debugging
+.TP
+\fB\-\-fn\fR, \fB\-\-font\fR <fontname>
+defines the application font
+.TP
+\fB\-\-bg\fR, \fB\-\-background\fR <color> sets the default background color and an
+application palette (light and dark shades are
+calculated)
+.HP
+\fB\-\-fg\fR, \fB\-\-foreground\fR <color> sets the default foreground color
+.TP
+\fB\-\-btn\fR, \fB\-\-button\fR <color>
+sets the default button color
+.TP
+\fB\-\-name\fR <name>
+sets the application name
+.TP
+\fB\-\-title\fR <title>
+sets the application title (caption)
+.TP
+\fB\-\-visual\fR TrueColor
+forces the application to use a TrueColor visual on
+an 8\-bit display
+.TP
+\fB\-\-inputstyle\fR <inputstyle> sets XIM (X Input Method) input style. Possible
+values are onthespot, overthespot, offthespot and
+root
+.TP
+\fB\-\-im\fR <XIM server>
+set XIM server
+.TP
+\fB\-\-noxim\fR
+disable XIM
+.TP
+\fB\-\-reverse\fR
+mirrors the whole layout of widgets
+.SS "TDE options:"
+.TP
+\fB\-\-caption\fR <caption>
+Use 'caption' as name in the titlebar
+.TP
+\fB\-\-icon\fR <icon>
+Use 'icon' as the application icon
+.TP
+\fB\-\-miniicon\fR <icon>
+Use 'icon' as the icon in the titlebar
+.TP
+\fB\-\-config\fR <filename>
+Use alternative configuration file
+.TP
+\fB\-\-dcopserver\fR <server>
+Use the DCOP Server specified by 'server'
+.TP
+\fB\-\-nocrashhandler\fR
+Disable crash handler, to get core dumps
+.TP
+\fB\-\-waitforwm\fR
+Waits for a WM_NET compatible windowmanager
+.TP
+\fB\-\-style\fR <style>
+sets the application GUI style
+.TP
+\fB\-\-geometry\fR <geometry>
+sets the client geometry of the main widget \- see man X for the argument format
+.TP
+\fB\-\-nofork\fR
+Don't run in the background.
+.SH "SEE ALSO"
+The full documentation for
+.B BasKet:
+is maintained as a TDE help file.
+If TDE, Konqueror and KHelpcenter is fully installed on your computer, accessing
+.IP
+.B help:/basket
+.PP
+should give you access to the complete manual.
+.SH "AUTHOR"
+.B BasKet
+Note Pads was written by
+.IP
+S\['e]bastien Lao\[^u]t <slaout@linux62.org>
+.IP
+Petri Damst\['e]n <damu@iki.fi>
+.IP
+Alex Gontmakher <gsasha@cs.technion.ac.il>
+.IP
+Marco Martin <m4rt@libero.it>
+.PP
+Please report bugs to slaout@linux62.org.
+.SH "OTHER"
+This manpage is derived from help2man by Sune Vuorela <debian@pusling.com> for the Debian project (But may be used by others). License: GPL2 like BasKet