diff options
author | Michele Calgaro <michele.calgaro@yahoo.it> | 2022-06-13 13:47:50 +0900 |
---|---|---|
committer | Michele Calgaro <michele.calgaro@yahoo.it> | 2022-06-13 15:42:17 +0900 |
commit | d8521af7be8cafc64525755758d25f0b70072ea5 (patch) | |
tree | 502917d6e35afa2e8aed5dfa71bbc129eb388f28 /doc/man/scripts | |
parent | 3cb0d9a6cdab412d4845af7a7994187f0a5507bb (diff) | |
download | tdesdk-d8521af7be8cafc64525755758d25f0b70072ea5.tar.gz tdesdk-d8521af7be8cafc64525755758d25f0b70072ea5.zip |
Add man pages for TDE applications
Signed-off-by: Michele Calgaro <michele.calgaro@yahoo.it>
Diffstat (limited to 'doc/man/scripts')
33 files changed, 1843 insertions, 0 deletions
diff --git a/doc/man/scripts/CMakeLists.txt b/doc/man/scripts/CMakeLists.txt new file mode 100644 index 00000000..24ccd704 --- /dev/null +++ b/doc/man/scripts/CMakeLists.txt @@ -0,0 +1,7 @@ +file( GLOB _man_files RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.1 ) + +INSTALL( + FILES ${_man_files} + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/scripts/adddebug.1 b/doc/man/scripts/adddebug.1 new file mode 100644 index 00000000..d78dad43 --- /dev/null +++ b/doc/man/scripts/adddebug.1 @@ -0,0 +1,45 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH ADDDEBUG 1 "January 31, 2004" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +adddebug \- modifies Makefile(s) to add debug info +.SH SYNOPSIS +.B adddebug +.RB "[ " \-k " ] [ " \-n " ] [ " \-r " ]" +.SH DESCRIPTION +\fBadddebug\fP modifies the \fIMakefile\fP in the current directory +(and optionally in its subdirectories) to add debug info (\fI\-g3\fP). +It will also remove optimisations (\fI\-O[1-9]?\fP), and can optionally +remove \fI\-DNDEBUG\fP and \fI\-DNO_DEBUG\fP as well. +.PP +This utility is part of the TDE Software Development Kit. +.SH OPTIONS +.TP +.B \-k +Keep optimisations (do not remove \fI\-O[1-9]?\fP flags which are +removed by default). +.TP +.B \-n +Compile without \fINDEBUG\fP and \fINO_DEBUG\fP being defined (this +makes kdDebug calls work). +.TP +.B \-r +Recursively search through all subdirectories of the current directory +and operate on every Makefile that is found. +.SH AUTHOR +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/build-progress.sh.1 b/doc/man/scripts/build-progress.sh.1 new file mode 100644 index 00000000..28c9d901 --- /dev/null +++ b/doc/man/scripts/build-progress.sh.1 @@ -0,0 +1,56 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH BUILD-PROGRESS.SH 1 "June 16, 2004" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +build-progress.sh \- show kde-build progress in your konsole/xterm title bar +.SH SYNOPSIS +.B build-progress.sh +.SH DESCRIPTION +\fBbuild-progress.sh\fP can be used to watch the progress of a large TDE +build in the title bar of your konsole or xterm. +.PP +The TDE build must be running elsewhere as a separate process, and it +must be done using +.BR kde-build (1). +.PP +When you run build-progress.sh, it will sit in a permanent loop while +kde-build runs. The title bar of the konsole/xterm in which you ran +build-progress.sh will be continually updated with the directory in +which the TDE build is currently working. +.PP +You must run build-progress.sh from the top-level directory of the TDE +build tree. This directory must contain a file named +\fIkde-buildrc\fP (which is also used by kde-build). This +\fIkde-buildrc\fP must contain valid settings for +\fITDELOGDIR\fP and \fITDESRCDIR\fP, or else build-progress.sh will +fail to work. +.PP +This utility is part of the TDE Software Development Kit. +.SH FILES +.TP +\fIkde-buildrc\fP +This file must be contained in the current directory, which must be the +root of the TDE build tree. See +.BR kde-build (1) +for further information. +.SH SEE ALSO +.BR kde-build (1). +.SH AUTHOR +build-progress.sh was written by Malte Starostik <malte@kde.org> and others. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/cheatmake.1 b/doc/man/scripts/cheatmake.1 new file mode 100644 index 00000000..098449a0 --- /dev/null +++ b/doc/man/scripts/cheatmake.1 @@ -0,0 +1,72 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH CHEATMAKE 1 "September 27, 2002" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +cheatmake \- fool make into not rebuilding certain files +.SH SYNOPSIS +.B cheatmake hidechange +.I file +.br +.B cheatmake show +.br +.B cheatmake why +.I file +.SH DESCRIPTION +\fBcheatmake\fP is used to save time when recompiling. It can fool \fBmake\fP +into skipping files that haven't changed in a meaningful way. This can be +used for instance when you change a comment in a file but none of the actual +code. +.PP +This utility is part of the TDE Software Development Kit. +.SH OPTIONS +The different modes of operation are as follows. +.TP +\fBhidechange\fP \fIfile\fP +Hides the fact that the given file has changed by moving its timestamp +back into the past. Use this option with care! +.TP +\fBshow\fP +Lists which files make currently needs to rebuild. +.TP +\fBwhy\fP \fIfile\fP +Explains why make must rebuild the given file. +.SH ENVIRONMENT VARIABLES +One of the following variables (but not both) should be set if the +source +directory is different from the build directory. +If the build directory is simply a subdirectory of the source directory, +the simpler variable OBJ_SUBDIR should be used. +.TP +OBJ_SUBDIR +Indicates that the build directory is in the given subdirectory of the +source directory. For instance, if the source directory is \fItdesdk\fP +and the build directory is \fItdesdk/obj-i386-linux\fP, then OBJ_SUBDIR +should be set to \fIobj-i386-linux\fP. +.TP +OBJ_REPLACEMENT +A \fBsed\fP expression that is used to transform the source directory +into the build directory. +For instance, if the source directory is \fI~/src/tdesdk\fP and the +build directory is \fI~/src/tdesdk-obj\fP, then OBJ_REPLACEMENT could +be set to \fIs#tdesdk#tdesdk-obj#\fP. +.SH SEE ALSO +.BR make (1). +.SH AUTHOR +cheatmake was written by David Faure <faure@kde.org>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/create_cvsignore.1 b/doc/man/scripts/create_cvsignore.1 new file mode 100644 index 00000000..ce63f6f5 --- /dev/null +++ b/doc/man/scripts/create_cvsignore.1 @@ -0,0 +1,42 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH CREATE_CVSIGNORE 1 "March 20, 2005" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +create_cvsignore \- creates preliminary .cvsignore in current directory +.SH SYNOPSIS +.B create_cvsignore +[ \fB\-r\fP ] +.SH DESCRIPTION +\fBcreate_cvsignore\fP is used to create a preliminary \fI.cvsignore\fP +file in the current directory. It does this by adding some standard +stuff according to what it finds in \fIMakefile.am\fP. +.PP +No lines will be removed from any existing \fI.cvsignore\fP. +If there is not already a \fI.cvsignore\fP, it will be added to the CVS +repository. +.PP +Note that you must have a \fIMakefile.am\fP in the current directory for +this tool to work. +.PP +This utility is part of the TDE Software Development Kit. +.SH OPTIONS +.TP +\fB-r\fP +Recursively process this directory and all directories beneath it. +.SH AUTHOR +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/create_makefile.1 b/doc/man/scripts/create_makefile.1 new file mode 100644 index 00000000..e128f23e --- /dev/null +++ b/doc/man/scripts/create_makefile.1 @@ -0,0 +1,69 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH CREATE_MAKEFILE 1 "September 26, 2002" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +create_makefile \- creates Makefile.in and Makefile from a Makefile.am +.SH SYNOPSIS +.B create_makefile +.I relativepath/Makefile +.br +.B create_makefile +.I relativepath +.SH DESCRIPTION +\fBcreate_makefile\fP creates the \fIMakefile.in\fP and \fIMakefile\fP +in a subdirectory containing a \fIMakefile.am\fP. +This script saves time compared to re-running configure completely. +.PP +Note that you must supply the path to the desired \fIMakefile\fP, not the +existing \fIMakefile.am\fP (though the final \fI/Makefile\fP may be omitted). +.PP +This script may be run from the toplevel directory (the +one containing \fIconfigure\fP) or from one of its subdirectories. +Note that \fIrelativepath\fP must be a relative path, not an absolute path. +.PP +If the source directory is different from the build directory (see the +environment variables below), it will be assumed that the \fIMakefile.am\fP +and \fIMakefile.in\fP belong beneath the source directory and that the +\fIMakefile\fP belongs beneath the build directory. +.PP +This utility is part of the TDE Software Development Kit. +.SH ENVIRONMENT VARIABLES +One of the following variables (but not both) should be set if the +source +directory is different from the build directory. +If the build directory is simply a subdirectory of the source directory, +the simpler variable OBJ_SUBDIR should be used. +.TP +OBJ_SUBDIR +Indicates that the build directory is in the given subdirectory of the +source directory. For instance, if the source directory is \fItdesdk\fP +and the build directory is \fItdesdk/obj-i386-linux\fP, then OBJ_SUBDIR +should be set to \fIobj-i386-linux\fP. +.TP +OBJ_REPLACEMENT +A \fBsed\fP expression that is used to transform the source directory +into the build directory. +For instance, if the source directory is \fI~/src/tdesdk\fP and the +build directory is \fI~/src/tdesdk-obj\fP, then OBJ_REPLACEMENT could +be set to \fIs#tdesdk#tdesdk-obj#\fP. +.SH SEE ALSO +.BR create_makefiles (1). +.SH AUTHOR +create_makefile was written by David Faure <faure@kde.org> and others. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/create_makefiles.1 b/doc/man/scripts/create_makefiles.1 new file mode 100644 index 00000000..2efc0379 --- /dev/null +++ b/doc/man/scripts/create_makefiles.1 @@ -0,0 +1,63 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH CREATE_MAKEFILES 1 "September 27, 2002" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +create_makefiles \- recreates all Makefiles beneath a directory +.SH SYNOPSIS +.B create_makefiles +.I dir +.SH DESCRIPTION +\fBcreate_makefiles\fP recreates all \fIMakefile\fPs in +\fIdir\fP and its (recursed) subdirectories from the corresponding +\fIMakefile.am\fP templates. +.PP +This script must be run from the toplevel directory (the +one containing \fIconfigure\fP). +This script saves time compared to re-running configure completely. +.PP +If the source directory is different from the build directory (see the +environment variables below), it will be assumed that each \fIMakefile.am\fP +and \fIMakefile.in\fP belongs beneath the source directory and that each +\fIMakefile\fP belongs beneath the build directory. +.PP +This utility is part of the TDE Software Development Kit. +.SH ENVIRONMENT VARIABLES +One of the following variables (but not both) should be set if the +source +directory is different from the build directory. +If the build directory is simply a subdirectory of the source directory, +the simpler variable OBJ_SUBDIR should be used. +.TP +OBJ_SUBDIR +Indicates that the build directory is in the given subdirectory of the +source directory. For instance, if the source directory is \fItdesdk\fP +and the build directory is \fItdesdk/obj-i386-linux\fP, then OBJ_SUBDIR +should be set to \fIobj-i386-linux\fP. +.TP +OBJ_REPLACEMENT +A \fBsed\fP expression that is used to transform the source directory +into the build directory. +For instance, if the source directory is \fI~/src/tdesdk\fP and the +build directory is \fI~/src/tdesdk-obj\fP, then OBJ_REPLACEMENT could +be set to \fIs#tdesdk#tdesdk-obj#\fP. +.SH SEE ALSO +.BR create_makefile (1). +.SH AUTHOR +create_makefiles was written by David Faure <faure@kde.org>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/cvs-clean.1 b/doc/man/scripts/cvs-clean.1 new file mode 100644 index 00000000..0706e485 --- /dev/null +++ b/doc/man/scripts/cvs-clean.1 @@ -0,0 +1,50 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH CVS-CLEAN 1 "March 20, 2005" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +cvs\-clean \- delete all files and directories not registered with CVS +.SH SYNOPSIS +.B cvs\-clean +[ \fB-n, \-\-dry-run\fP ] +[ \fB-h, \-\-help\fP ] +.SH DESCRIPTION +\fBcvs\-clean\fP recursively deletes everything in or beneath the +current directory that is not known to CVS (i.e., that has not been +checked out of or checked into a CVS repository). +.PP +A list of all files and directories that are deleted will be written to +the console. +.PP +This script behaves similarly to the \fIcvs-clean\fP target from the +file \fIadmin/Makefile.common\fP found in most TDE application sources. +.PP +This utility is part of the TDE Software Development Kit. +.SH OPTIONS +.TP +\fB-n, \-\-dry-run\fP +Print the intended actions to the console, but do not change anything on +the filesystem. +.TP +\fB-h, \-\-help\fP +Display usage information. +.SH SEE ALSO +.BR cvs (1). +.SH AUTHOR +This utility was written by Oswald Buddenhagen <ossi@kde.org>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/cvs2dist.1 b/doc/man/scripts/cvs2dist.1 new file mode 100644 index 00000000..f0bc71a3 --- /dev/null +++ b/doc/man/scripts/cvs2dist.1 @@ -0,0 +1,201 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH CVS2DIST 1 "March 19, 2005" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +cvs2dist \- convert subdirectories within TDE CVS into standalone +source packages +.SH SYNOPSIS +.B cvsdist +.I path-to-module +.I directory-in-module +[ \fB\-n, \-\-name\fP \fIname\fP ] +[ \fB\-v, \-\-version\fP \fIversion\fP ] +[ \fB\-\-admin-dir\fP \fIdir\fP ] +[ \fB\-\-cvs-root\fP \fIroot\fP ] +[ \fB\-B, \-\-branch\fP \fIbranch\fP ] +[ \fB\-\-no-i18n\fP ] +[ \fB\-\-no-i18n-lang\fP \fIlanguages\fP ] +[ \fB\-\-log=\fP\fIlogfile\fP | \fB\-l\fP ] +[ \fB\-m, \-\-make-unpackaged\fP ] +[ \fB\-g, \-\-no-gzip\fP ] +[ \fB\-b, \-\-no-bz2, \-\-no-bzip2\fP ] +[ \fB\-o, \-\-only-directory\fP ] +[ \fB\-r, \-\-required-header\fP \fIheader\fP ] +[ \fB\-e, \-\-required-header-error-message\fP \fImessage\fP ] +[ \fB\-d, \-\-remove-hidden\fP ] +[ \fB\-\-replace-files\fP \fIpairs\fP ] +[[--] \fIaddfile\fP ... ] +.PP +.B cvsdist +\fB\-h, \-\-help\fP +.SH DESCRIPTION +Each module in the TDE CVS tree contains a large number of applications +all bundled together. +\fBcvs2dist\fP is used to extract a single application or component from +one of these large CVS modules and bundle it into a standalone package. +The application or component will be bundled into a standard +distribution tarball (with a configure script and so on) that users can +download, build and install. +.PP +By default, cvs2dist automatically tries to check out all translations +of strings and documentation from the corresponding parts of the +\fItde-i18n\fP CVS module and include them in the final packages. +This can be suppressed or modified using the options \-\-no-i18n or +\-\-no-i18n-lang. +.PP +The initial argument \fIpath-to-module\fP should specify where the CVS +module has been checked out on your system, and the second argument +\fIdirectory-in-module\fP should specify which directory within this +module is to be packaged (all subdirectories beneath it will be included +and so on). See the EXAMPLE section below for details. +.PP +Both gzip and bzip2 compressed tarballs will be created by default and +will be called \fIname[-version].tar.gz\fP and \fIname[-version].tar.bz2\fP. +The \fIname\fP component will be the last directory component of +\fIdirectory-in-module\fP unless otherwise specified by \-\-name, and +the \fIversion\fP component will not be included unless it is specified by +\-\-version. +.PP +Additional files from outside the CVS tree can be included in the final +packages by passing them after all other options (these are the +\fIaddfile\fP arguments displayed above). These additional files will +be placed in the top level directory of the final packages. +The \-\- that precedes them is optional. +.PP +Many options are available for customising these procedures, as seen below. +Note that cvs2dist will remove any temporary files that it creates. +.PP +This utility is part of the TDE Software Development Kit. +.SH OPTIONS +.TP +\fB\-n, \-\-name\fP \fIname\fP +The name of the package (to be used in the names of the final tarballs +and directories). Specifically, the compressed tarballs will be called +\fIname-version.tar.gz\fP and \fIname-version.tar.bz2\fP (see the +\-\-version option below for further information). +This package name defaults to the last directory component of +\fIdirectory-in-module\fP. +.TP +\fB\-v, \-\-version\fP \fIversion\fP +The version of the package (to be used in the names of the final +tarballs and directories). If this is not supplied, no version is used +at all (i.e., the compressed tarballs will just be called \fIname.tar.gz\fP +and \fIname.tar.bz2\fP). +.TP +\fB\-\-admin-dir\fP \fIdir\fP +The location of \fIadmin/\fP on the filesystem. Symbolic links may +be used. Defaults to \fIpath-to-module/admin\fP. +.TP +\fB\-\-cvs-root\fP \fIroot\fP +The value to use as CVSROOT when checking out translations from CVS. +Defaults to the CVSROOT environment variable. +If \-\-no-i18n is passed then this option has no effect. +.TP +\fB\-B, \-\-branch\fP \fIbranch\fP +Use the given CVS branch for checking out translations from CVS. +If \-\-no-i18n is passed then this option has no effect. +.TP +\fB\-\-no-i18n\fP +Do not check out any translations from CVS. +.TP +\fB\-\-no-i18n-lang\fP \fIlanguages\fP +Exclude the given language(s) when checking out translations from CVS. +The list of languages should be comma-separated, +such as \fI\-\-no-i18n-lang uk,de,en_GB\fP . +.TP +\fB\-\-log=\fP\fIlogfile\fP +Log all proceedings to the given logfile. Note that the = is essential, +and may not be omitted. +.TP +\fB\-l\fP +Log all proceedings to the default logfile in the current directory. +.TP +\fB\-m, \-\-make-unpackaged\fP +In addition to the compressed tarballs, an unpacked distribution will be +created in the current directory. +.TP +\fB\-g, \-\-no-gzip\fP +Do not create a gzip package (\fIname-version.tar.gz\fP). +.TP +\fB\-b, \-\-no-bz2, \-\-no-bzip2\fP +Do not create a bzip2 package (\fIname-version.tar.bz2\fP). +.TP +\fB\-o, \-\-only-directory\fP +Alias for \-mgb. No packages will be created, only an unpacked directory. +.TP +\fB\-r, \-\-required-header\fP \fIheader\fP +When the user runs configure, an error will be generated if +\fIheader\fP is not found on the user's system. +.TP +\fB\-e, \-\-required-header-error-message\fP \fImessage\fP +The error to display to a user when the header passed with +\-\-required-header is not found on the user's system. Defaults to a +sensible message. +.TP +\fB\-d, \-\-remove-hidden\fP +Remove hidden files and directories (e.g., dotfiles) from the packages. +.TP +\fB\-h, \-\-help\fP +Display instructions on how to use cvs2dist. +.TP +\fB\-\-replace-files\fP \fIpairs\fP +Move one or more files around in the final distribution packages. +The \fIpairs\fP argument should be a comma-separated list of +replacements to make. Each replacement specifies a single file to move, and +should be of the form \fIsource\fP@\fIdest\fP. +.br +For each replacement, the source file will be moved to the +destination file (in particular, the source file will be deleted). +All filenames are relative to the top-level directory +of the package. Spaces in filenames are not allowed. +.br +Please be careful when using this option! Try to avoid the use of .. +in the filenames, since it may cause unexpected problems. +.br +An example of this option might be +\fI\-\-replace-files take_this_file@move_it_here,configure.in.bot.dist@configure.in.bot\fP . +.SH EXAMPLE +The following example creates packages of the kolf picture plugin from +the CVS source tree currently checked out in \fI/sources\fP. +.PP +.RS +\fIexample$\fP cvs2dist /sources/tdegames kolf/objects/picture +\-n kolf-picture \-v 0.9 \-r "kolf/game.h" \-\-log ~/tmp/extra-file +.RE +.PP +The packages will be named \fIkolf-picture-0.9\fP and +the process will be logged. For configure to succeed when a user builds +these packages, the header \fIkolf/game.h\fP must be installed or an +error will occur. The additional file \fI~/tmp/extra-file\fP will be +included in the packages even though it is not part of the CVS source tree. +.SH FILES +.TP +\fI~/.cvs2distrc\fP +Any options found in this file will be +added to the beginning of the command-line arguments. +.SH SEE ALSO +.BR cvs (1). +.PP +For the latest updates to this script, see the cvs2dist website +\fIhttp://www.katzbrown.com/shiritsu/programming/cvs2dist/\fP. +.SH AUTHOR +cvs2dist was written by Jason Katz-Brown <jason@katzbrown.com>, +Sebastian Stein <seb.stein@hpfsc.de>, Dominique Devriese <devriese@kde.org> +and Michael Buesch <mbuesch@freenet.de>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/cvsbackport.1 b/doc/man/scripts/cvsbackport.1 new file mode 100644 index 00000000..7181ac67 --- /dev/null +++ b/doc/man/scripts/cvsbackport.1 @@ -0,0 +1,52 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH CVSBACKPORT 1 "March 20, 2005" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +cvsbackport \- backport the last change in HEAD to a branch +.SH SYNOPSIS +.B cvsbackport +\fIfile\fP ... +.SH DESCRIPTION +For each file given on the command line, +\fBcvsbackport\fP will attempt to determine the last change made to +the file in HEAD and then backport that change to a CVS branch (the +branch name is hard-coded; see below). +.PP +The changes to be backported will be displayed on screen, and you will +have the chance to confirm or abort before any commits are made. +.PP +The files must be checked out from HEAD when you run this utility. +.PP +This utility is part of the TDE Software Development Kit. +.SH WARNINGS +The branch tag is hard-coded into the script (currently it is set to +KDE_3_4_BRANCH). +.PP +If you abort (i.e., you do not make the suggested commits), your files +will be checked out from the branch (and not from HEAD as they were +before). +.SH SEE ALSO +.BR cvsblame (1), +.BR cvsforwardport (1), +.BR cvslastchange (1), +.BR cvslastlog (1), +.BR cvsrevertlast (1). +.SH AUTHOR +This utility was written by Dirk Mueller and David Faure. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/cvscheck.1 b/doc/man/scripts/cvscheck.1 new file mode 100644 index 00000000..3d79c255 --- /dev/null +++ b/doc/man/scripts/cvscheck.1 @@ -0,0 +1,107 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH CVSCHECK 1 "March 26, 2005" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +cvscheck \- offline status report for files in a checked-out CVS module +.SH SYNOPSIS +.B cvscheck +[ \fB\-u, \-\-unknown\fP ] +[ \fB\-m, \-\-modified\fP ] +[ \fB\-\-missing\fP ] +[ \fB\-t, \-\-tagged\fP ] +[ \fB\-a, \-\-added\fP ] +[ \fB\-r, \-\-removed\fP ] +[ \fB\-c, \-\-conflicts\fP ] +[ \fB\-l, \-\-local\fP ] +[ \fIdir\fP ... ] +.SH DESCRIPTION +\fBcvscheck\fP prints information about the status of your local CVS +checkout without communicating with the server. This means it is +extremely fast and does not require a network connection. +.PP +The given directories and all of their subdirectories will be processed +recursively (though see the \-\-local option below). +If no directory is given, the current directory and its +recursed subdirectories will be used. +.PP +Each file with an interesting status will be printed with a status +character in front of its name. The status characters are as follows. +.TP +? \fIfoobar.c\fP +The file is not known to CVS. Maybe you should add it? +.TP +M \fIfoobar.c\fP +The file is for sure locally modified. +.TP +m \fIfoobar.c\fP +The file \fImight\fP have local changes. You should diff with the +server to make sure. +.TP +C \fIfoobar.c\fP +The file has a CVS conflict and therefore cannot be committed. +.TP +U \fIfoobar.c\fP +The file is in CVS but is somehow missing in your local checkout. +.TP +T \fIfoobar.c\fP +The file has an unusual sticky CVS tag. +.TP +A \fIfoobar.c\fP +You have "cvs add"ed this file but you have not yet committed. +.TP +R \fIfoobar.c\fP +You have "cvs remove"d this file but you have not yet committed. +.PP +This utility is part of the TDE Software Development Kit. +.SH OPTIONS +By default cvscheck will display the status for all files in and +beneath the requested directories. The following options however can be +used to display only files with a particular status and/or in a +particular directory. +.TP +\fB\-u, \-\-unknown\fP +Show only unknown (?) files. +.TP +\fB\-m, \-\-modified\fP +Show only modified (m/M) files. +.TP +\fB\-\-missing\fP +Show only missing (U) files. +.TP +\fB\-t, \-\-tagged\fP +Show only tagged (T) files. +.TP +\fB\-a, \-\-added\fP +Show only added (A) files. +.TP +\fB\-r, \-\-removed\fP +Show only removed (R) files. +.TP +\fB\-c, \-\-conflicts\fP +Show only conflict (C) files. +.TP +\fB\-l, \-\-local\fP +Do not recurse. That is, process the given directory but none of its +subdirectories. +.SH SEE ALSO +.BR cvs (1). +.SH AUTHOR +cvscheck was written by Dirk Mueller <mueller@kde.org> and +Sirtaj Singh Kang <taj@kde.org>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/cvsforwardport.1 b/doc/man/scripts/cvsforwardport.1 new file mode 100644 index 00000000..0ca6d29f --- /dev/null +++ b/doc/man/scripts/cvsforwardport.1 @@ -0,0 +1,52 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH CVSFORWARDPORT 1 "March 20, 2005" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +cvsforwardport \- forwardport the last change in a branch to HEAD +.SH SYNOPSIS +.B cvsforwardport +\fIfile\fP ... +.SH DESCRIPTION +For each file given on the command line, +\fBcvsforwardport\fP will attempt to determine the last change made to +the file in the primary CVS branch and then forwardport that change to HEAD. +The branch name is hard-coded; see below. +.PP +The changes to be forwardported will be displayed on screen, and you will +have the chance to confirm or abort before any commits are made. +.PP +The files must be checked out from the branch when you run this utility. +.PP +This utility is part of the TDE Software Development Kit. +.SH WARNINGS +The branch tag is hard-coded into the script (currently it is set to +KDE_3_4_BRANCH). +.PP +If you abort (i.e., you do not make the suggested commits), your files +will be checked out from HEAD (and not from the branch as they were +before). +.SH SEE ALSO +.BR cvsbackport (1), +.BR cvsblame (1), +.BR cvslastchange (1), +.BR cvslastlog (1), +.BR cvsrevertlast (1). +.SH AUTHOR +This utility was written by Dirk Mueller and David Faure. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/cvslastchange.1 b/doc/man/scripts/cvslastchange.1 new file mode 100644 index 00000000..b651e441 --- /dev/null +++ b/doc/man/scripts/cvslastchange.1 @@ -0,0 +1,59 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH CVSLASTCHANGE 1 "March 20, 2005" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +cvslastchange \- display the last committed changes for a file +.SH SYNOPSIS +.B cvslastchange +\fIfile\fP [ \fIrevision\fP ] +.br +.B cvslastchange +\fBM\fP +\fIdigits\fP -\fIdigits\fP +.I file revision +.SH DESCRIPTION +\fBcvslastchange\fP displays the last changes committed to the CVS +for the given file. +It does this by launching '\fIcvs log\fP' and '\fIcvs diff\fP'. +.PP +If a revision is passed, the changes committed for that particular revision +will be displayed. Otherwise the currently checked out revision will be used. +.PP +This tool works with other branches as well as with HEAD. +.PP +This utility is part of the TDE Software Development Kit. +.SH OPTIONS +.TP +\fBM\fP +\fIdigits\fP -\fIdigits\fP +These options are currently ignored. +.SH ENVIRONMENT VARIABLES +.TP +CVSLASTCHANGE_KEEP_WHITESPACE +Define this variable if you do not want the whitespace to be modified +in any way when displaying changes. Usually the whitespace is tidied +up a little before the changes are displayed on screen. +.br +This variable is useful if you are using cvslastchange to extract a +patch that can be applied elsewhere. +.SH SEE ALSO +.BR cvsbackport (1), +.BR cvsblame (1), +.BR cvsforwardport (1), +.BR cvslastlog (1), +.BR cvsrevertlast (1). +.SH AUTHOR +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/cvslastlog.1 b/doc/man/scripts/cvslastlog.1 new file mode 100644 index 00000000..445a1a74 --- /dev/null +++ b/doc/man/scripts/cvslastlog.1 @@ -0,0 +1,39 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH CVSLASTLOG 1 "March 20, 2005" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +cvslastlog \- prints the log of the last commit for a file +.SH SYNOPSIS +.B cvslastlog +.I file +.SH DESCRIPTION +\fBcvslastlog\fP shows the log associated with the last CVS commit for the +given file. +It depends on the version of the local file, not the one on the server. +.PP +This utility is part of the TDE Software Development Kit. +.SH SEE ALSO +.BR cvsbackport (1), +.BR cvsblame (1), +.BR cvsforwardport (1), +.BR cvslastchange (1), +.BR cvsrevertlast (1). +.SH AUTHOR +cvslastlog was written by David Faure <faure@kde.org>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/cvsrevertlast.1 b/doc/man/scripts/cvsrevertlast.1 new file mode 100644 index 00000000..aedf45aa --- /dev/null +++ b/doc/man/scripts/cvsrevertlast.1 @@ -0,0 +1,38 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH CVSREVERTLAST 1 "March 20, 2005" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +cvsrevertlast \- revert files in CVS by one version +.SH SYNOPSIS +.B cvsrevertlast +\fIfile\fP ... +.SH DESCRIPTION +\fBcvsrevertlast\fP is used to revert all the files on the command line +by one version in CVS. The files will not be committed. +.PP +This utility is part of the TDE Software Development Kit. +.SH SEE ALSO +.BR cvsbackport (1), +.BR cvsblame (1), +.BR cvsforwardport (1), +.BR cvslastchange (1), +.BR cvslastlog (1). +.SH AUTHOR +This utility was written by Charles Samuels <charles@kde.org>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/cxxmetric.1 b/doc/man/scripts/cxxmetric.1 new file mode 100644 index 00000000..a8a855cd --- /dev/null +++ b/doc/man/scripts/cxxmetric.1 @@ -0,0 +1,34 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH CXXMETRIC 1 "January 31, 2004" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +cxxmetric \- simple source metrics for C and C++ +.SH SYNOPSIS +.B cxxmetric +.RI "[ " file " ... ]" +.SH DESCRIPTION +\fBcxxmetric\fP counts lines of code, comment and blank space and +calculates various other statistics for each given source file. +Source files must be in C or C++. +.PP +If no source files are specified then all C/C++ files in or beneath the +current directory will be used. +.PP +This utility is part of the TDE Software Development Kit. +.SH AUTHOR +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/extend_dmalloc.1 b/doc/man/scripts/extend_dmalloc.1 new file mode 100644 index 00000000..0078442e --- /dev/null +++ b/doc/man/scripts/extend_dmalloc.1 @@ -0,0 +1,43 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH EXTEND_DMALLOC 1 "April 29, 2001" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +extend_dmalloc \- analyse return-addresses from dmalloc logfiles +.SH SYNOPSIS +.B extend_dmalloc +.I dmalloc-log binary +.SH DESCRIPTION +\fBextend_dmalloc\fP will run +.BR gdb (1) +to get information on the return-addresses from a +.BR dmalloc (1) +logfile. Specifically it will examine any \fIra=\fP lines and try to +get the corresponding line numbers. +.PP +The argument \fIbinary\fP must be the binary that generated the log +\fIdmalloc-log\fP. +.PP +This utility is part of the TDE Software Development Kit. +.SH NOTES +You may wish to direct the output from extend_dmalloc to a file, since +otherwise gdb seems to prompt for a return as if you are at the end of a +page. +.SH AUTHOR +extend_dmalloc was written by Gray Watson <gray.watson@letters.com>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/extractattr.1 b/doc/man/scripts/extractattr.1 new file mode 100644 index 00000000..7e506e44 --- /dev/null +++ b/doc/man/scripts/extractattr.1 @@ -0,0 +1,61 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH EXTRACTATTR 1 "March 20, 2005" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +extractattr \- extract element attributes from UI and XML GUI files +.SH SYNOPSIS +.B extractattr +\fB\-\-attr=\fP\fIname\fP +[ \fB\-\-attr=\fP\fIname\fP ... ] +[ \fB\-\-context=\fP\fIname\fP ] +\fIfile\fP ... +.PP +.B extractattr \-\-help +.SH DESCRIPTION +\fBextractattr\fP finds all of the given element attributes within the +given files. It then writes the corresponding \fIi18n()\fP calls to +standard output (usually redirected to rc.cpp) so that xgettext can parse +them. Only the attributes specified by \fB\-\-attr\fP will be extracted. +.PP +Both Qt designer (.ui) files and XML GUI (.rc) files are understood. +.PP +This utility is part of the TDE Software Development Kit. +.SH OPTIONS +.TP +\fB\-\-attr=\fP\fIname\fP +Specifies an attribute to be extracted. This option may be used +multiple times. +.br +The \fIname\fP argument must be of the form +\fIElement\fP,\fIattribute\fP or +\fIElement\fP,\fIattribute\fP,\fIcontext\fP. +.br +The context is optional, and is used in constructing the i18n() calls. +If specified it will override the default context set by \fB\-\-context\fP. +.TP +\fB\-\-context=\fP\fIname\fP +Give all i18n() calls the given context: i18n("\fIname\fP", ...). +.TP +\fB\-\-help\fP +Display a summary of options. +.SH EXAMPLE +extractattr \-\-attr=Title,data \-\-attr=Description,data,Stencils file.ui +.SH AUTHOR +This utility was written by Richard Evans <rich@ridas.com> and others. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/extractrc.1 b/doc/man/scripts/extractrc.1 new file mode 100644 index 00000000..130fdb08 --- /dev/null +++ b/doc/man/scripts/extractrc.1 @@ -0,0 +1,60 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH EXTRACTRC 1 "March 20, 2005" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +extractrc \- extract message strings from UI and XML GUI files +.SH SYNOPSIS +.B extractrc +[ \fB\-\-tag\-group=\fP\fIgroup\fP ] +[ \fB\-\-tag=\fP\fIname\fP ... ] +[ \fB\-\-context=\fP\fIname\fP ] +\fIfile\fP ... +.PP +.B extractrc \-\-help +.SH DESCRIPTION +\fBextractrc\fP finds all text tags and other message strings within the +given files. It then writes the corresponding \fIi18n()\fP calls to +standard output (usually redirected to rc.cpp) so that xgettext can parse +them. +.PP +It understands both Qt designer (.ui) files and XML GUI (.rc) files. +.PP +This utility is part of the TDE Software Development Kit. +.SH OPTIONS +Note that the old \fB\-\-lines\fP option is deprecated; source line +numbers are now always included in comments. +.TP +\fB\-\-tag\-group=\fP\fIgroup\fP +Use a predefined group of tags that we are interested in. +Valid groups are default, koffice and none. +The default group will be used if this option is omitted. +.TP +\fB\-\-tag=\fP\fIname\fP +Extract also the contents of the tag \fIname\fP. +This option may be used multiple times +(e.g., \-\-tag=tag_one \-\-tag=tag_two). +.TP +\fB\-\-context=\fP\fIname\fP +Give all i18n() calls the given context: i18n("\fIname\fP", ...). +.TP +\fB\-\-help\fP +Display a summary of options. +.SH AUTHOR +This utility was written by Richard Evans <rich@ridas.com> and others. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/findmissingcrystal.1 b/doc/man/scripts/findmissingcrystal.1 new file mode 100644 index 00000000..32b23294 --- /dev/null +++ b/doc/man/scripts/findmissingcrystal.1 @@ -0,0 +1,42 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH FINDMISSINGCRYSTAL 1 "February 6, 2004" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +findmissingcrystal \- determine which TDE Crystal icons are the same as +the TDE Classic hicolor icons +.SH SYNOPSIS +.B findmissingcrystal +.I module +.SH DESCRIPTION +\fBfindmissingcrystal\fP is a small utility that runs through the icons +in the given TDE module and determines which Crystal icons from that +module are identical to the old TDE Classic hicolor icons. +.PP +This script \fBmust\fP be run from the top-level directory of a TDE source +tree (i.e., the directory containing \fItdelibs\fP, \fItdebase\fP, etc.). +It is assumed that \fImodule\fP is a top-level module in the source tree, +and it is also assumed that the source tree contains the \fItdeartwork\fP +module (which contains the old hicolor icons). +.PP +For each Crystal icon in the given module, a message will be output +describing whether the icon is new (no matching hicolor icon was found), +different from the hicolor icon or the same as the hicolor icon. +.PP +This utility is part of the TDE Software Development Kit. +.SH AUTHOR +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/fixkdeincludes.1 b/doc/man/scripts/fixkdeincludes.1 new file mode 100644 index 00000000..6c5bea18 --- /dev/null +++ b/doc/man/scripts/fixkdeincludes.1 @@ -0,0 +1,73 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH FIXTDEINCLUDES 1 "January 31, 2004" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +fixkdeincludes \- reduce the number of #includes in TDE source files +.SH SYNOPSIS +.B fixkdeincludes +[ \fB\-v, \-\-verbose\fP ] +[ \fB\-e, \-\-experimental\fP ] +[ \fB\-m, \-\-modify\fP ] +[ \fIfile\fP ... ] +.br +.B fixkdeincludes \-\-help +.SH DESCRIPTION +\fBfixkdeincludes\fP tries to reduce the number of #includes in C++ source +files. Much of its processing is specific to TDE sources and so it +might not work so well with sources for non-TDE applications. +.PP +The following problems are identified by fixkdeincludes: +.PP +.RS +Including headers that are no longer supported but which exist for +compatibility with older Qt/KDE versions; +.PP +Including the same file multiple times; +.PP +Using #include <...> instead of #include "...". +.RE +.PP +There is also an experimental mode which tries removing each #include +one at a time (with a few exceptions) to see whether the source still +compiles. Note that this experimental mode will modify the original sources. +.PP +By default the sources will not be modified; the identified problems +will simply be written to standard output. +.PP +The list of C++ sources to examine should be given on the command-line. +If no files are given, all C++ sources in or beneath the current +directory will be examined (with the exception of directories whose +\fIMakefile.am\fP contains \-UTQT_NO_COMPAT or \-UTDE_NO_COMPAT). +.PP +This utility is part of the TDE Software Development Kit. +.SH OPTIONS +.TP +\fB\-v, \-\-verbose\fP +Verbose mode. Additional debugging information is written to standard output. +.TP +\fB\-e, \-\-experimental\fP +Experimental mode, as described above in detail. Note that this option +implies \fB\-\-modify\fP. +.TP +\fB\-m, \-\-modify\fP +As well as writing messages to standard output, actually modify the +original sources to fix any problems that were found. +.SH AUTHOR +fixkdeincludes was written by Dirk Mueller <mueller@kde.org>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/fixuifiles.1 b/doc/man/scripts/fixuifiles.1 new file mode 100644 index 00000000..17ce46a6 --- /dev/null +++ b/doc/man/scripts/fixuifiles.1 @@ -0,0 +1,63 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH FIXUIFILES 1 "March 20, 2005" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +fixuifiles \- remove undesirable features from TQt/TDE .ui files +.SH SYNOPSIS +.B fixuifiles +[ \fB\-v, \-\-verbose\fP ] +[ \fB\-\-omitqtcheck\fP ] +[ \fIfile\fP ... ] +.br +.B fixuifiles \-\-help +.SH DESCRIPTION +\fBfixuifiles\fP processes one or more TQt/TDE user interface definition +files (.ui files) and tries to remove some of the insanities found +therein. If no filenames are given, fixuifiles will process all .ui +files in or beneath the current directory. +.PP +The following problems are fixed: +.PP +.RS +Too high minimum Qt version; +.PP +Hardcoded untranslatable Alt+Letter accels (auto-added by Qt Designer); +.PP +Captions that are equal to class names (auto-added by Qt Designer). +.RE +.PP +The threshold Qt version can be set +using either a \fI.qt_minversion\fP file (containing simply the Qt version +number) or a \fIconfigure.in.in\fP file (containing an appropriate +MIN_CONFIG macro). These files may be in the directory containing the .ui +file or any parent directory. If no threshold Qt version is found, +a sensible default will be used. +.PP +This utility is part of the TDE Software Development Kit. +.SH OPTIONS +.TP +\fB\-v, \-\-verbose\fP +Verbose mode. Additional debugging information is written to standard output. +.TP +\fB\-\-omitqtcheck\fP +Do not check the minimum Qt version. +.SH AUTHOR +fixuifiles was written by David Faure <faure@kde.org> and +Dirk Mueller <mueller@kde.org>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/kdedoc.1 b/doc/man/scripts/kdedoc.1 new file mode 100644 index 00000000..1911442c --- /dev/null +++ b/doc/man/scripts/kdedoc.1 @@ -0,0 +1,42 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH TDEDOC 1 "January 31, 2004" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +kdedoc \- view documentation for a TDE class +.SH SYNOPSIS +.B kdedoc +.I classname +.SH DESCRIPTION +\fBkdedoc\fP opens the documentation for the TDE class \fIclassname\fP +in kfm/konqueror. Note that the class name is case sensitive. It is +assumed that you have the tdelibs documentation installed. +.PP +This utility is part of the TDE Software Development Kit. +.SH EXAMPLES +To bring up help on the class TDEAboutDialog: +.PP +.RS +kdedoc TDEAboutDialog +.RE +.SH DEBIAN USERS +The tdelibs documentation is in the Debian package \fItdelibs4-doc\fP, +which will need to be installed. +.SH SEE ALSO +.BR qtdoc (1). +.SH AUTHOR +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/kdelnk2desktop.py.1 b/doc/man/scripts/kdelnk2desktop.py.1 new file mode 100644 index 00000000..41cce73a --- /dev/null +++ b/doc/man/scripts/kdelnk2desktop.py.1 @@ -0,0 +1,39 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH KDELNK2DESKTOP.PY 1 "November 14, 2002" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +kdelnk2desktop.py \- converts .kdelnk to .desktop +.SH SYNOPSIS +.B kdelnk2desktop.py +.RI "[ " kdelnk-file " ] ..." +.SH DESCRIPTION +\fBkdelnk2desktop.py\fP is used to convert +a \fI.kdelnk\fP file (used by KDE 1) into a \fI.desktop\fP +file (used by KDE 2 and later). +.PP +File \fIkdelnk-file\fP must have a name ending in \fI.kdelnk\fP. +After kdelnk2desktop.py is run, this will be replaced by a new file +ending in \fI.desktop\fP. The original \fIkdelnk-file\fP will be +removed. +.PP +This utility is part of the TDE Software Development Kit. +.SH WARNING +If \fIkdelnk-file\fP does not end in \fI.kdelnk\fP, +the results of this script are unpredictable. +.SH AUTHOR +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/kdemangen.pl.1 b/doc/man/scripts/kdemangen.pl.1 new file mode 100644 index 00000000..8acd79df --- /dev/null +++ b/doc/man/scripts/kdemangen.pl.1 @@ -0,0 +1,51 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH KDEMANGEN.PL 1 "October 15, 2004" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +kdemangen.pl \- automatically create a draft manpage for a TDE app +.SH SYNOPSIS +.B kdemangen.pl +.I /path/to/application +.SH DESCRIPTION +\fBkdemangen.pl\fP will automatically create a draft manpage for a TDE +application. Manpages are always better when hand-tailored, but this +should give you a fairly good start. +.PP +To create the manpage, it will use the \-\-author and \-\-help\-all +output for the application passed on the command line. +It will also use the description in the +Debian control file if one is available. To make use of this additional +feature, you must run kdemangen.pl from within the \fIdebian/\fP +subdirectory of the application sources. +.PP +The new manpage will be written to standard output. +.PP +This utility is part of the TDE Software Development Kit. +.SH WARNING +This utility will only work for a full TDE application that uses +TDECmdLineArgs (which most full TDE applications do). +.SH EXAMPLE +.RS +cd /path/to/tde/srcs/tdeedu/debian +.br +kdemangen /usr/bin/kstars > kstars.1 +.RE +.SH AUTHOR +kdemangen.pl was written by Dominique Devriese <devriese@kde.org>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/licensecheck.1 b/doc/man/scripts/licensecheck.1 new file mode 100644 index 00000000..48728f2c --- /dev/null +++ b/doc/man/scripts/licensecheck.1 @@ -0,0 +1,37 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH LICENSECHECK 1 "January 31, 2004" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +licensecheck \- simple license checker for source files +.SH SYNOPSIS +.B licensecheck +.RB "[ " \-v " ]" +\fIfile\fP ... +.SH DESCRIPTION +\fBlicensecheck\fP examines the comments at the beginning of each given +source file and tries to determine which license the file is placed +under. It does this by searching for blocks of text that it recognises +as belonging to various licenses. +.PP +This utility is part of the TDE Software Development Kit. +.SH OPTIONS +.TP +.B \-v +Verbose mode. +.SH AUTHOR +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/makeobj.1 b/doc/man/scripts/makeobj.1 new file mode 100644 index 00000000..50a9f864 --- /dev/null +++ b/doc/man/scripts/makeobj.1 @@ -0,0 +1,66 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH MAKEOBJ 1 "March 20, 2005" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +makeobj \- run make from the correct directory +.SH SYNOPSIS +.B makeobj +[ \fImake-argument\fP ... ] +.SH DESCRIPTION +\fBmakeobj\fP is a wrapper around \fBmake\fP which basically checks +whether it's in the source directory or the build directory and changes +to the correct directory before calling make. +.PP +The command-line arguments will (generally) be passed directly to make. +.PP +This script is useful if the source directory is different from the +build directory and the Makefiles are kept in the build directory, as is +common for instance when building the TDE sources. This script can however +be used in more standard scenarios (such as non-TDE projects for which the +source and build directories are the same), where it will behave just like +make. +.PP +One of the environment variables OBJ_SUBDIR or OBJ_REPLACEMENT +should be set to indicate where the build directory is in relation to +the source directory. +.PP +This utility is part of the TDE Software Development Kit. +.SH ENVIRONMENT VARIABLES +Note that only one of OBJ_SUBDIR and OBJ_REPLACEMENT should be used. +If the build directory is simply a subdirectory of the source directory, +the simpler variable OBJ_SUBDIR should be used. +.TP +OBJ_SUBDIR +Indicates that the build directory is in the given subdirectory of the +source directory. For instance, if the source directory is \fItdesdk\fP +and the build directory is \fItdesdk/obj-i386-linux\fP, then OBJ_SUBDIR +should be set to \fIobj-i386-linux\fP. +.TP +OBJ_REPLACEMENT +A \fBsed\fP expression that is used to transform the source directory +into the build directory. +For instance, if the source directory is \fI~/src/tdesdk\fP and the +build directory is \fI~/src/tdesdk-obj\fP, then OBJ_REPLACEMENT could +be set to \fIs#src/tdesdk#src/tdesdk-obj#\fP. +.SH SEE ALSO +.BR make (1), +.BR sed (1). +.SH AUTHOR +makeobj was written by Stephan Kulow <coolo@kde.org>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/package_crystalsvg.1 b/doc/man/scripts/package_crystalsvg.1 new file mode 100644 index 00000000..32d8644e --- /dev/null +++ b/doc/man/scripts/package_crystalsvg.1 @@ -0,0 +1,41 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH PACKAGE_CRYSTALSVG 1 "October 15, 2004" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +package_crystalsvg \- bundle up Crystal SVG sources from a TDE checkout +.SH SYNOPSIS +.B package_crystalsvg +.SH DESCRIPTION +\fBpackage_crystalsvg\fP assumes that the current directory contains one +or more checked-out TDE modules. It searches these modules for Crystal +SVG vector sources (.svgz or .svg.gz files) +and packages them up into a tarball. The tarball will also +contain \fIFILES\fP (describing the contents of the tarball and which +TDE modules/paths they were copied from) as well as some other bits and +pieces. +.PP +Note that you must at least have tdelibs checked out for this utility to +run. +.PP +The final tarball will be created in the current working directory. +.PP +This utility is part of the TDE Software Development Kit. +.SH AUTHOR +package_crystalsvg was written by Frans Englich <frans.englich@telia.com>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/png2mng.pl.1 b/doc/man/scripts/png2mng.pl.1 new file mode 100644 index 00000000..c86c1727 --- /dev/null +++ b/doc/man/scripts/png2mng.pl.1 @@ -0,0 +1,49 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH PNG2MNG.PL 1 "October 15, 2004" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +png2mng.pl \- combine a set of PNG images into an animated MNG image +.SH SYNOPSIS +.B png2mng.pl +.I basename width height +.SH DESCRIPTION +\fBpng2mng.pl\fP reads a sequence of PNG images and combines them into +a single animated MNG image. +.PP +The individual PNG images should be numbered consecutively from zero up, +and should have names of the form +.I basenameXXXX +where +.I XXXX +is the four-digit sequence number (0000, 0001, 0002, etc). +The width and height of the PNG images should +also be included on the command line. +.PP +The final animated MNG image will be written to standard output. +.PP +This utility is part of the TDE Software Development Kit. +.SH EXAMPLE +The following example will combine the files hi32-action-kde-0000.png, +hi32-action-kde-0001.png, hi32-action-kde-0002.png, etc., and write +the resulting animated image to hi32-action-kde.mng: +.PP +.RS +png2mng.pl hi32-action-kde- 32 32 > hi32-action-kde.mng +.RE +.SH AUTHOR +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/pruneemptydirs.1 b/doc/man/scripts/pruneemptydirs.1 new file mode 100644 index 00000000..108c7e4d --- /dev/null +++ b/doc/man/scripts/pruneemptydirs.1 @@ -0,0 +1,65 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH PRUNEEMPTYDIRS 1 "September 27, 2002" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +pruneemptydirs \- detects stale source dirs in a CVS tree +.SH SYNOPSIS +.B pruneemptydirs +[ \fB\-f\fP ] +.SH DESCRIPTION +\fBpruneemptydirs\fP is used to clean up a local CVS tree. +It detects directories containing remnants of old stuff which has been +removed from the CVS. Such stale directories often break compilation. +The current directory and all directories beneath it will be examined. +.PP +Note that this tool does not remove anything; it simply prints what to +do as a series of remove commands. You can copy and paste these commands, +or use them with eval in a script. +.PP +This tool works better if the source directory is not the same as the +build directory, since it will not print directories containing old +executables. +.PP +This utility is part of the TDE Software Development Kit. +.SH OPTIONS +.TP +\fB\-f\fP +Actually perform the deletions instead of just printing them out. +Use this option with care (no warranties, etc.)! +.SH ENVIRONMENT VARIABLES +One of the following variables (but not both) should be set if the source +directory is different from the build directory. +If the build directory is simply a subdirectory of the source directory, +the simpler variable OBJ_SUBDIR should be used. +.TP +OBJ_SUBDIR +Indicates that the build directory is in the given subdirectory of the +source directory. For instance, if the source directory is \fItdesdk\fP +and the build directory is \fItdesdk/obj-i386-linux\fP, then OBJ_SUBDIR +should be set to \fIobj-i386-linux\fP. +.TP +OBJ_REPLACEMENT +A \fBsed\fP expression that is used to transform the source directory +into the build directory. +For instance, if the source directory is \fI~/src/tdesdk\fP and the +build directory is \fI~/src/tdesdk-obj\fP, then OBJ_REPLACEMENT could +be set to \fIs#tdesdk#tdesdk-obj#\fP. +.SH AUTHOR +pruneemptydirs was written by David Faure <faure@kde.org>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/qtdoc.1 b/doc/man/scripts/qtdoc.1 new file mode 100644 index 00000000..3b7c09f6 --- /dev/null +++ b/doc/man/scripts/qtdoc.1 @@ -0,0 +1,50 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH QTDOC 1 "January 31, 2004" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +qtdoc \- view documentation for a Qt class +.SH SYNOPSIS +.B qtdoc +.RI "[ " classname " ]" +.SH DESCRIPTION +\fBqtdoc\fP opens a Qt help page in kfm/konqueror. +If \fIclassname\fP is given, it opens the help page for that class (note +that the class name is case insensitive). Otherwise the main Qt help +page is opened. It is assumed that you have the Qt documentation +installed. +.PP +This utility is part of the TDE Software Development Kit. +.SH ENVIRONMENT VARIABLES +.TP +QTDIR +The directory beneath which the Qt documentation is installed. +Thus the main Qt help page should be in \fI$QTDIR/doc/html/\fP. +If $QTDIR is not set, \fI/usr/share/qt3\fP will be assumed. +.SH EXAMPLES +To bring up help on class QString: +.PP +.RS +qtdoc QString +.RE +.SH DEBIAN USERS +The Qt documentation is in the Debian package \fIqt3-doc\fP, which will +need to be installed. +.SH SEE ALSO +.BR kdedoc (1). +.SH AUTHOR +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/tdekillall.1 b/doc/man/scripts/tdekillall.1 new file mode 100644 index 00000000..92bf4380 --- /dev/null +++ b/doc/man/scripts/tdekillall.1 @@ -0,0 +1,36 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH TDEKILLALL 1 "April 29, 2001" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +tdekillall \- kills processes started with tdeinit +.SH SYNOPSIS +.B tdekillall +[ \fB\-\fP\fIsignal\fP ] \fIprocess-name\fP +.SH DESCRIPTION +\fBtdekillall\fP kills all processes with a particular name +that were started through tdeinit. Specifically, it kills all processes +\fBtdeinit:\fP \fIprocess-name\fP. +.PP +This utility is part of the TDE Software Development Kit. +.SH OPTIONS +.TP +\fB\-\fP\fIsignal\fP +Kill the processes with signal \fIsignal\fP. This option defaults to +SIGTERM. Run \fIkill \-l\fP for a list of possible signals. +.SH AUTHOR +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/scripts/zonetab2pot.py.1 b/doc/man/scripts/zonetab2pot.py.1 new file mode 100644 index 00000000..d6a4330a --- /dev/null +++ b/doc/man/scripts/zonetab2pot.py.1 @@ -0,0 +1,39 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH ZONETAB2POT.PY 1 "November 14, 2002" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +zonetab2pot.py \- converts a timezone list to a PO-file template +.SH SYNOPSIS +.B zonetab2pot.py +[ \fItimezone-list\fP ] +.SH DESCRIPTION +\fBzonetab2pot.py\fP reads the timezone list given on the command-line +and converts it to a gettext message file (PO-file) template containing +the names of the individual timezones. +.PP +The given timezone list should be in the same format as the system +\fIzone.tab\fP. If no timezone list is specified on the command-line, +\fI/usr/share/zoneinfo/zone.tab\fP will be used. +.PP +The new PO-file template will be written to standard output. +.PP +This utility is part of the TDE Software Development Kit. +.SH AUTHOR +zonetab2pot.py was written by Lukas Tinkl <lukas@kde.org>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). |