diff options
author | gregory guy <gregory-tde@laposte.net> | 2020-10-12 15:43:57 +0200 |
---|---|---|
committer | gregory guy <gregory-tde@laposte.net> | 2020-11-02 17:30:41 +0100 |
commit | a9c86866c380e503dd75797b5c2d129bfb622a9e (patch) | |
tree | 7f082c4dc920583aea947d773459d9d29b7b65ef /doc | |
parent | 99525910c366e86d76dfeb818697220703578e8a (diff) | |
download | ktechlab-a9c86866c380e503dd75797b5c2d129bfb622a9e.tar.gz ktechlab-a9c86866c380e503dd75797b5c2d129bfb622a9e.zip |
Conversion to the cmake building system.
Added man pages taken from the Debian packaging system.
Move the ktechlab.desktop file into XDG_APPS_INSTALL_DIR directory,
see TDE/tde#26 and bug 2408.
Signed-off-by: gregory guy <gregory-tde@laposte.net>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/CMakeLists.txt | 34 | ||||
-rw-r--r-- | doc/man/CMakeLists.txt | 7 | ||||
-rw-r--r-- | doc/man/ktechlab.1 | 151 | ||||
-rw-r--r-- | doc/man/microbe.1 | 162 |
4 files changed, 354 insertions, 0 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt new file mode 100644 index 0000000..f6eec15 --- /dev/null +++ b/doc/CMakeLists.txt @@ -0,0 +1,34 @@ +file( GLOB _dirs RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} * ) +list( REMOVE_ITEM _dirs html man ) + +string( REGEX REPLACE "[ \r\n\t]+" ";" _linguas "$ENV{LINGUAS}" ) + +foreach( _dir IN LISTS _dirs ) + if( IS_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/${_dir} + AND ( "${_dir}" STREQUAL "en" OR + "${_linguas}" MATCHES "^;*$" OR + ";${_linguas};" MATCHES ";${_dir};" )) + file( GLOB _doc_files RELATIVE ${CMAKE_CURRENT_SOURCE_DIR}/${_dir} ${_dir}/*.docbook ) + if( _doc_files ) + list( FIND _doc_files "index.docbook" _find_index ) + if( -1 EQUAL _find_index ) + set( _noindex "NOINDEX" ) + else() + unset( _noindex ) + endif() + tde_create_handbook( + SOURCE_BASEDIR ${_dir} + ${_noindex} + LANG ${_dir} + DESTINATION ${PROJECT_NAME} + ) + endif() + endif() +endforeach() + +if( EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/html/CMakeLists.txt ) + add_subdirectory( html ) +endif() +if( EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/man/CMakeLists.txt ) + add_subdirectory( man ) +endif() diff --git a/doc/man/CMakeLists.txt b/doc/man/CMakeLists.txt new file mode 100644 index 0000000..5c8c2e4 --- /dev/null +++ b/doc/man/CMakeLists.txt @@ -0,0 +1,7 @@ +##### man pages + +INSTALL( + FILES ${PROJECT_NAME}.1 microbe.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/ktechlab.1 b/doc/man/ktechlab.1 new file mode 100644 index 0000000..bb49c1d --- /dev/null +++ b/doc/man/ktechlab.1 @@ -0,0 +1,151 @@ +.\" This file was generated by kdemangen.pl +.TH KTECHLAB 1 "Jan 2006" "Trinity Desktop Environment" "An IDE for microcontrollers and electronics" +.SH NAME +ktechlab +\- An IDE for microcontrollers and electronics +.SH SYNOPSIS +ktechlab [Qt\-options] [TDE\-options] [URL] +.SH DESCRIPTION +An IDE for microcontrollers and electronics +.SH OPTIONS +.SS +.SS Arguments: +.TP +.B URL +Document to open. +.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 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 - see man X for the argument format +.SS +.SS Qt options: +.TP +.B \-\-display <displayname> +Use the X-server display 'displayname' +.TP +.B \-\-session <sessionId> +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 <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 +.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 <fontname> +defines the application font +.TP +.B \-\-bg, \-\-background <color> +sets the default background color and an +application palette (light and dark shades are +calculated) +.TP +.B \-\-fg, \-\-foreground <color> +sets the default foreground color +.TP +.B \-\-btn, \-\-button <color> +sets the default button color +.TP +.B \-\-name <name> +sets the application name +.TP +.B \-\-title <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 + +.SH SEE ALSO +Full user documentation is available through the TDE Help Center. You can also enter the URL +.BR help:/ktechlab/ +directly into konqueror or you can run +.BR "`khelpcenter help:/ktechlab/'" +from the command-line. +.br +.SH AUTHORS +.nf +David Saxton <david@bluehaze.org> +.br +Daniel Clarke <daniel.jc@gmail.com> +.br + diff --git a/doc/man/microbe.1 b/doc/man/microbe.1 new file mode 100644 index 0000000..bbe54c3 --- /dev/null +++ b/doc/man/microbe.1 @@ -0,0 +1,162 @@ +.\" This file was generated by kdemangen.pl +.TH MICROBE 1 "Jan 2006" "Trinity Desktop Environment" "The Microbe Compiler" +.SH NAME +microbe +\- The Microbe Compiler +.SH SYNOPSIS +microbe [Qt\-options] [TDE\-options] [options] [Input URL] [Output URL] +.SH DESCRIPTION + +.SH OPTIONS +.SS +.SS Arguments: +.TP +.B Input +URL Input filename +.TP +.B Output +URL Output filename +.SS Options: +.TP +.B \-\-show\-source +Show source code lines in assembly output +.TP +.B \-\-nooptimize +Do not attempt optimization of generated instructions. +.SS +.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 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 - see man X for the argument format +.SS +.SS Qt options: +.TP +.B \-\-display <displayname> +Use the X-server display 'displayname' +.TP +.B \-\-session <sessionId> +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 <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 +.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 <fontname> +defines the application font +.TP +.B \-\-bg, \-\-background <color> +sets the default background color and an +application palette (light and dark shades are +calculated) +.TP +.B \-\-fg, \-\-foreground <color> +sets the default foreground color +.TP +.B \-\-btn, \-\-button <color> +sets the default button color +.TP +.B \-\-name <name> +sets the application name +.TP +.B \-\-title <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 + +.SH SEE ALSO +Full user documentation is available through the TDE Help Center. You can also enter the URL +.BR help:/microbe/ +directly into konqueror or you can run +.BR "`khelpcenter help:/microbe/'" +from the command-line. +.br +.SH AUTHORS +.nf +Daniel Clarke <daniel.jc@gmail.com> +.br +David Saxton <david@bluehaze.org> +.br + |