diff options
| author | Slávek Banko <slavek.banko@axis.cz> | 2021-01-15 13:12:21 +0100 |
|---|---|---|
| committer | Slávek Banko <slavek.banko@axis.cz> | 2021-01-15 13:13:17 +0100 |
| commit | fd24c73cb34da8db534aec43b859999dea6a47d0 (patch) | |
| tree | bccc5d1b4216a1f3bcaa3fbc1e4e901830131725 /doc | |
| parent | 1e3a83b5cfae052d95badae698d09bb7c727af4a (diff) | |
| download | tdenetworkmanager-fd24c73c.tar.gz tdenetworkmanager-fd24c73c.zip | |
Use common cmake rules for documentation.
Move the documentation to the usual layout.
Signed-off-by: Slávek Banko <slavek.banko@axis.cz>
(cherry picked from commit 8c180d8033d4bbb04f11123703f18ca1aabe0647)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/CMakeLists.txt | 34 | ||||
| -rw-r--r-- | doc/en/index.docbook | 66 | ||||
| -rw-r--r-- | doc/man/CMakeLists.txt | 5 | ||||
| -rw-r--r-- | doc/man/tdenetworkmanager.1 | 145 |
4 files changed, 250 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/en/index.docbook b/doc/en/index.docbook new file mode 100644 index 0000000..68e7bfd --- /dev/null +++ b/doc/en/index.docbook @@ -0,0 +1,66 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY tdenetworkmanager "<application>TDE Network Manager</application>"> + <!ENTITY kappname "&tdenetworkmanager;"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<article lang="&language;"> +<title>The &kappname; Handbook</title> + +<articleinfo> +<title>The &kappname; Handbook</title> + +<authorgroup> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<!-- <legalnotice>&FDLNotice;</legalnotice> --> + +<abstract> +<para> +&kappname; is a system tray utility to manage network connections. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>network</keyword> +<keyword>manager</keyword> +<keyword>connection</keyword> +<keyword>connections</keyword> +<keyword>wired</keyword> +<keyword>wireless</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="apologies"> +<title>We Apologize</title> +<para>No documentation has yet been written for &kappname;.</para> + +<para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde; +web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php"> +&tde; mail lists</ulink>, or file a bug report at the <ulink url="http://bugs.trinitydesktop.org/"> +&tde; bug tracker</ulink>.</para> + +<para>If you are interested in helping, please consider writing the help file. +Submitting a basic text file is acceptable as the &tde-team; will convert the text.</para> + +<para>Thank you for helping and thank you for your patience.</para> + +&underFDL; + +</sect1> + +</article> 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/tdenetworkmanager.1 b/doc/man/tdenetworkmanager.1 new file mode 100644 index 0000000..0f1abef --- /dev/null +++ b/doc/man/tdenetworkmanager.1 @@ -0,0 +1,145 @@ +.\" This file was generated by kdemangen.pl +.TH TDENETWORKMANAGER 1 "Feb 2006" "Trinity Desktop Environment" "A NetworkManager front-end for TDE" +.SH NAME +tdenetworkmanager +\- A NetworkManager front-end for TDE +.SH SYNOPSIS +tdenetworkmanager [Qt\-options] [TDE\-options] +.SH DESCRIPTION +A NetworkManager front-end for TDE +.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 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 +.TP +.B \-\-nofork +Don't run in the background. +.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 +.BR networkmanager (1) +.SH AUTHORS +.nf +Timo Hoenig <thoenig@suse.de> +.br +Stefan Bogner <sbogner@suse.de> +.br +Will Stephenson <wstephenson@suse.de> +.br + |
