Add man pages for TDE applications.

Signed-off-by: Michele Calgaro <michele.calgaro@yahoo.it>
pull/13/head
Michele Calgaro 2 years ago
parent 9f06a008b5
commit 825599fcff
Signed by: MicheleC
GPG Key ID: 2A75B7CA8ADED5CF

@ -109,9 +109,9 @@ tde_conditional_add_subdirectory( BUILD_KNEWSTICKER_SCRIPTS knewsticker-scripts
tde_conditional_add_subdirectory( BUILD_KONQ_PLUGINS konq-plugins )
tde_conditional_add_subdirectory( BUILD_KSIG ksig )
tde_conditional_add_subdirectory( BUILD_NOATUN_PLUGINS noatun-plugins )
tde_conditional_add_subdirectory( BUILD_RENAMEDLG_PLUGINS renamedlgplugins)
tde_conditional_add_subdirectory( BUILD_TDEFILE_PLUGINS tdefile-plugins)
tde_conditional_add_subdirectory( BUILD_TUTORIALS tutorials)
tde_conditional_add_subdirectory( BUILD_RENAMEDLG_PLUGINS renamedlgplugins )
tde_conditional_add_subdirectory( BUILD_TDEFILE_PLUGINS tdefile-plugins )
tde_conditional_add_subdirectory( BUILD_TUTORIALS tutorials )
##### write configure files #####################

@ -1,3 +1,8 @@
# This file is genereted by trinity-automake-cmake-convert script by Fat-Zer
add_subdirectory( man )
tde_auto_add_subdirectories( )
tde_conditional_add_subdirectory( BUILD_ATLANTIKDESIGNER atlantikdesigner )
tde_conditional_add_subdirectory( BUILD_KATE_PLUGINS kate-plugins )
tde_conditional_add_subdirectory( BUILD_KICKER_APPLETS kicker-applets )
tde_conditional_add_subdirectory( BUILD_KONQ_PLUGINS konq-plugins )
tde_conditional_add_subdirectory( BUILD_KSIG ksig )
tde_conditional_add_subdirectory( BUILD_TUTORIALS tutorials )

@ -0,0 +1,5 @@
tde_conditional_add_subdirectory( BUILD_ATLANTIKDESIGNER atlantikdesigner )
tde_conditional_add_subdirectory( BUILD_KONQ_PLUGINS konq-plugins )
tde_conditional_add_subdirectory( BUILD_KSIG ksig )
tde_conditional_add_subdirectory( BUILD_NOATUN_PLUGINS noatun-plugins )
tde_conditional_add_subdirectory( BUILD_TDEFILE_PLUGINS tdefile-plugins )

@ -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
)

@ -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 ATLANTIKDESIGNER 1 "October 14, 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
atlantikdesigner \- game board designer for Atlantik
.SH SYNOPSIS
.B atlantikdesigner
.RI "[ " generic-options " ]"
.SH DESCRIPTION
\fBAtlantik Designer\fP is a game board designer for Atlantik.
.PP
Atlantik is a TDE client for playing Monopoly-like board games on the
monopd network. It can play any board supported by the network
server, including the classic Monopoly game as well as the Atlantik
game in which the properties include several major cities in North
America and Europe.
.PP
This application is part of the official TDE add-ons module.
.SH OPTIONS
For a full summary of options, run \fIatlantikdesigner \-\-help\fP.
.SH SEE ALSO
.BR atlantik (6).
.SH AUTHOR
Atlantik Designer was written by Jason Katz-Brown <jason@katzbrown.com>
and Rob Kaper <cap@capsi.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).

@ -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
)

@ -0,0 +1,44 @@
.\" 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 EXIF.PY 1 "February 4, 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
exif.py \- extract EXIF information from digital camera image files
.SH SYNOPSIS
.B exif.py
\fIimage-file\fP ...
.SH DESCRIPTION
This is a Python library for extracting EXIF tags from digital camera
image files. It contains a command-line testing and debugging interface,
which reads EXIF tags from the given files and dumps them to the
console.
.PP
This library is provided with the image conversion and transformation
plugins for Konqueror. The JPEG rotation/reflection tool \fBjpegorient\fP,
part of the same set of plugins, makes use of this library.
.PP
This utility is part of the official TDE add-ons module.
.SH SEE ALSO
.BR jpegorient (1),
.BR konqueror (1),
.BR orient.py (1).
.SH AUTHOR
The EXIF extraction library was written by Thierry Bousch
<bousch@topo.math.u-psud.fr>, Gene Cash <gcash@cfl.rr.com> and
Leif Jensen <jensen@math.columbia.edu>.
.br
This manual page was prepared by Ben Burton <bab@debian.org>
for the Debian GNU/Linux system (but may be used by others).

@ -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 FSVIEW 1 "February 4, 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
fsview \- a filesystem viewer that graphically shows disk usage
.SH SYNOPSIS
.B fsview
.RI "[ " generic-options " ]"
[ \fIfolder\fP ]
.SH DESCRIPTION
\fBFSView\fP is a tool for showing disc utilization in a graphical form, much
like the UNIX command 'du'. The visualisation type chosen is a
treemap. Each directory is represented by a rectangle whose area is
proportional to its size. Each directory rectangle contains smaller
rectangles for its contents, and so on down.
.PP
FSView is provided both as a Konqueror plugin for viewing directories,
and as a standalone executable.
.PP
This application is part of the official TDE add-ons module.
.SH OPTIONS
Below are the fsview-specific options.
For a full summary of options, run \fIfsview \-\-help\fP.
.TP
\fIfolder\fP
View the filesystem starting from this folder.
.SH SEE ALSO
.BR du (1),
.BR kdirstat (1),
.BR konqueror (1).
.PP
For a full featured graphical 'du', see KDirStat. It's quite similar
to FSView, but allows for lot of cleanup actions.
.SH AUTHOR
FSView was written by Josef Weidendorfer <Josef.Weidendorfer@gmx.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).

@ -0,0 +1,68 @@
.\" 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 JPEGORIENT 1 "October 13, 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
jpegorient \- change the orientations of JPEG images
.SH SYNOPSIS
.B jpegorient
{ \fB\-90\fP | \fB\-180\fP | \fB\-270\fP | \fB\-v\fP | \fB\-h\fP }
\fIimage-file\fP ...
.SH DESCRIPTION
This is a simple utility for changing the orientations of one or more
JPEG images.
It is provided as part of the image conversion and transformation
plugins for Konqueror.
.PP
A single option must be passed before any filenames to specify how the
orientations of the images are to be changed. Each new image will be
saved over the old one.
.PP
This utility makes use of
.BR orient.py (1),
which is designed to work with certain types of digital camera image
files. Instead of modifying the image data, it alters the EXIF
tags stored with the image to reflect the new orientation. For this
reason only images with the correct types of EXIF tags can be changed
using this tool.
.PP
This utility is part of the official TDE add-ons module.
.SH OPTIONS
.TP
\fB\-90\fP
Rotate each image by 90 degrees clockwise.
.TP
\fB\-180\fP
Rotate each image by a half turn (i.e., 180 degrees).
.TP
\fB\-270\fP
Rotate each image by 270 degrees clockwise (i.e., 90 degrees counter-clockwise).
.TP
\fB\-v\fP
Flip each image vertically.
.TP
\fB\-h\fP
Flip each image horizontally.
.SH SEE ALSO
.BR exif.py (1),
.BR konqueror (1),
.BR orient.py (1).
.SH AUTHOR
The image transformation plugins were written by
Leif Jensen <jensen@math.columbia.edu>.
.br
This manual page was prepared by Ben Burton <bab@debian.org>
for the Debian GNU/Linux system (but may be used by others).

@ -0,0 +1,88 @@
.\" 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 ORIENT.PY 1 "October 13, 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
orient.py \- change the orientation of a digital camera image file
.SH SYNOPSIS
.B orient.py
.I image-file
.br
.B orient.py
[1-8]
.I image-file
.SH DESCRIPTION
This is a small script for changing the orientation of certain types
of digital camera image files. The image data is not modified, but
rather the EXIF tags stored with the image are altered to reflect the
new orientation. For this reason only images with the correct types of
EXIF tags can be changed using this script.
.PP
When called with with a numeric argument from 1 to 8, the orientation
will be changed as described in the options section below. When called
with only a filename, the current orientation will be written to the
console (also as a number from 1 to 8).
.PP
If the image contains no EXIF information or if the EXIF information is not
of the correct type, an error will be displayed and this script will
exit immediately.
.PP
This script is provided with the image conversion and transformation
plugins for Konqueror. For a more general-purpose JPEG rotation/reflection
tool, see
.BR jpegorient (1)
which is also a part of this same set of plugins.
.PP
This utility is part of the official TDE add-ons module.
.SH OPTIONS
The possible orientations are represented by the numbers 1 to 8 as
follows.
.TP
.B 1
No change of orientation.
.TP
.B 2
Flip horizontally.
.TP
.B 3
Rotate by a half turn (i.e., 180 degrees).
.TP
.B 4
Flip vertically.
.TP
.B 5
Transpose image (i.e., reflect across the upper-left to lower-right
diagonal axis).
.TP
.B 6
Rotate by 90 degrees clockwise.
.TP
.B 7
Transverse transpose image (i.e., reflect across the upper-right to
lower-left diagonal axis).
.TP
.B 8
Rotate by 270 degrees clockwise (i.e., 90 degrees counter-clockwise).
.SH SEE ALSO
.BR exif.py (1),
.BR jpegorient (1),
.BR konqueror (1).
.SH AUTHOR
The image transformation plugins were written by
Leif Jensen <jensen@math.columbia.edu>.
.br
This manual page was prepared by Ben Burton <bab@debian.org>
for the Debian GNU/Linux system (but may be used by others).

@ -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
)

@ -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 KSIG 1 "February 4, 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
ksig \- a graphical tool for managing multiple email signatures
.SH SYNOPSIS
.B ksig
.RI "[ " generic-options " ]"
[ \fB\-\-random\fP | \fB\-\-daily\fP ]
.SH DESCRIPTION
\fBKSig\fP is a graphical tool for keeping track of many different email
signatures. The signatures themselves can be edited through KSig's
graphical user interface. This is done by starting KSig in the usual way
through the menus, or by running KSig without either of the special
options \-\-random or \-\-daily.
.PP
A direct command-line interface is then available for generating random
or daily signatures from this list. This is achieved by running KSig
with one of the options \-\-random or \-\-daily, both of which are
described below.
.PP
The command-line interface makes a suitable plugin for generating
signatures in external mail clients such as KMail. See
\fI/opt/trinity/share/doc/ksig/README.Debian\fP for details on how this can be
done.
.PP
This application is part of the official TDE add-ons module.
.SH OPTIONS
Below are the ksig-specific options.
For a full summary of options, run \fIksig \-\-help\fP.
.TP
\fB\-\-random\fP
Write a random signature from the list to the console.
.TP
\fB\-\-daily\fP
Write a signature for the day to the console. The signature will change
from day to day, but multiple calls on the same day will always return
the same signature.
.SH SEE ALSO
.BR kmail (1).
.SH AUTHOR
KSig was written by Scott Wheeler <wheeler@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).

@ -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
)

@ -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 NOATUNSYNAESCOPE.BIN 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
noatunsynaescope.bin \- start the Synaescope visualisation plugin for Noatun
.SH SYNOPSIS
.B noatunsynaescope.bin
.SH DESCRIPTION
This program starts the Synaescope visualisation plugin for Noatun, the audio
and video media player for TDE.
.PP
This program is for Noatun's internal use and should \fBnot\fP be run
directly. To start the plugin, run Noatun and select Plugins from the
configuration dialog.
.PP
This plugin is part of the TDE addons module.
.SH SEE ALSO
.BR noatun (1).
.SH AUTHOR
The Synaescope plugin was written by Charles Samuels <charles@kde.org>,
Paul Francis Harrison <pfh@yoyo.cc.monash.edu.au> et al.
.br
This manual page was prepared by Ben Burton <bab@debian.org>
for the Debian GNU/Linux system (but may be used by others).

@ -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 NOATUNTIPPECANOE.BIN 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
noatuntippecanoe.bin \- start the Tippecanoe visualisation plugin for Noatun
.SH SYNOPSIS
.B noatuntippecanoe.bin
.SH DESCRIPTION
This program starts the Tippecanoe visualisation plugin for Noatun, the audio
and video media player for TDE.
.PP
This program is for Noatun's internal use and should \fBnot\fP be run
directly. To start the plugin, run Noatun and select Plugins from the
configuration dialog.
.PP
This plugin is part of the TDE addons module.
.SH SEE ALSO
.BR noatun (1).
.SH AUTHOR
The Tippecanoe plugin was written by Neil Stevens <multivac@fcmail.com>,
Charles Samuels <charles@kde.org> and
Paul Francis Harrison <pfh@yoyo.cc.monash.edu.au>.
.br
This manual page was prepared by Ben Burton <bab@debian.org>
for the Debian GNU/Linux system (but may be used by others).

@ -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 NOATUNTYLER.BIN 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
noatuntyler.bin \- start the Tyler visualisation plugin for Noatun
.SH SYNOPSIS
.B noatuntyler.bin
.SH DESCRIPTION
This program starts the Tyler visualisation plugin for Noatun, the audio
and video media player for TDE.
.PP
This program is for Noatun's internal use and should \fBnot\fP be run
directly. To start the plugin, run Noatun and select Plugins from the
configuration dialog.
.PP
This plugin is part of the TDE addons module.
.SH SEE ALSO
.BR noatun (1).
.SH AUTHOR
The Tyler plugin was written by Neil Stevens <multivac@fcmail.com>,
Julien Carme <julien.carme@acm.org>, Charles Samuels <charles@kde.org>
and Mitja Horvat <Mitja.Horvat@hermes.si>.
.br
This manual page was prepared by Ben Burton <bab@debian.org>
for the Debian GNU/Linux system (but may be used by others).

@ -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
)

@ -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 LNKFORWARD 1 "October 23, 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
lnkforward \- open an URL in a Windows .lnk file under TDE
.SH SYNOPSIS
.B lnkforward
[ \fIgeneric-options\fP ]
[ \fB\-\-map\fP \fIdrive\fP=\fIpath\fP ... ]
\fIURL\fP
.SH DESCRIPTION
\fBlnkforward\fP examines a Windows .lnk file, determines its target and
then opens this target file. In deciding how to open the target file,
the usual TDE file associations will be used.
.PP
The given URL must include a protocol. Specifically, if it is simply a
file on the local filesystem, it must be given in the form
\fIfile:/path/to/file.lnk\fP.
.PP
Drive mappings must be supplied (via \-\-map) for any Windows drive
referred to in the .lnk file. See the OPTIONS section below for details.
.PP
This utility is used by the .lnk tdefile plugin, and is
part of the official TDE add-ons module.
.SH OPTIONS
Below are the lnkforward-specific options.
For a full summary of options, run \fIlnkforward \-\-help\fP.
.TP
\fB\-\-map\fP \fIdrive\fP=\fIpath\fP
Map the given Windows drive to the given path on the local filesystem
(generally its mount point).
This option may be passed multiple times.
.SH EXAMPLE
Suppose that the Windows file \fIc:\\readme.txt.lnk\fP is a link to
\fId:\\foo\\bar.txt\fP. Then the following command will open the file
\fI/mnt/data/foo/bar.txt\fP in the usual TDE text editor:
.PP
.RS
\fIprompt$\fP
lnkforward \-\-map c=/mnt/windows \-\-map d=/mnt/data /mnt/windows/readme.lnk
.RE
.SH AUTHOR
This utility was written by Martin Koller <m.koller@surfeu.at>.
.br
This manual page was prepared by Ben Burton <bab@debian.org>
for the Debian GNU/Linux system (but may be used by others).
Loading…
Cancel
Save