diff options
author | gregory guy <[email protected]> | 2020-03-29 19:41:28 +0200 |
---|---|---|
committer | gregory guy <[email protected]> | 2021-01-26 11:52:09 +0100 |
commit | 6b3181cf92f1fc74da1e8a82f690a1526cb4e900 (patch) | |
tree | b2bcaa0683427ddc2a1d692870d731c238f6cce8 /doc/man/kmag | |
parent | e09ebe446c909827c78f7c6d76b94ce4adea139d (diff) | |
download | tdeaccessibility-6b3181cf92f1fc74da1e8a82f690a1526cb4e900.tar.gz tdeaccessibility-6b3181cf92f1fc74da1e8a82f690a1526cb4e900.zip |
Conversion to the cmake building system.
Added several man pages taken from the Debian packaging.
Cleanup headers in ui files.
Add png icons for mono theme.
Signed-off-by: gregory guy <[email protected]>
cmake:
- Use tde_add_check_executable instead of a combination
of separate calls to tde_add_executable and add_test.
- Simplify the detection of time.h and sys/time.h headers.
- Refactor phrasebook files install, kmouth.
Signed-off-by: Slávek Banko <[email protected]>
Diffstat (limited to 'doc/man/kmag')
-rw-r--r-- | doc/man/kmag/CMakeLists.txt | 5 | ||||
-rw-r--r-- | doc/man/kmag/kmag.1 | 141 |
2 files changed, 146 insertions, 0 deletions
diff --git a/doc/man/kmag/CMakeLists.txt b/doc/man/kmag/CMakeLists.txt new file mode 100644 index 0000000..1c1513b --- /dev/null +++ b/doc/man/kmag/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES kmag.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kmag/kmag.1 b/doc/man/kmag/kmag.1 new file mode 100644 index 0000000..f21a158 --- /dev/null +++ b/doc/man/kmag/kmag.1 @@ -0,0 +1,141 @@ +.TH kmag 1 + +.SH NAME +kmag \- A screen magnifier for TDE. + +.SH SYNOPSIS +.B kmag [file] +.I [ Generic Options] [Qt-options] [TDE-options] + +.SH DESCRIPTION +Kmag is a TDE screen magnifier for the visually impaired. +You can use it to magnify a part of the screen just as you would use a +lens to magnify a newspaper fine-print or a photograph. +This application is useful for a variety of people: from researchers to +artists to web-designers to people with low vision. + +.SH GENERIC OPTIONS +.TP +.B \-\-help +Show help about options. +.TP +.B \-\-help-qt +Show Qt specific options. +.TP +.B \-\-help-tde +Show TDE specific options. +.TP +.B \-\-help-all +Show all options. +.TP +.B \-\-author +Show author information. +.TP +.B \-v, \-\-version +Show version information. + +.SH QT OPTIONS +.TP +.B \-\-display \fI<displayname>\fB +Use the X-server display `displayname'. +.TP +.B \-\-session \fI<sessionId>\fB +Restore the application for the given `sessionId'. +.TP +.B \-\-cmap +Causes the application to install a private color map on an 8\-bit +display. +.TP +.B \-\-ncols \fI<count>\fB +Limits the number of colors allocated in the color cube on an 8\-bit +display, if the application is using the QApplication::ManyColor color +specification. +.TP +.B \-\-nograb +Tells Qt to never grab the mouse or the keyboard. +.TP +.B \-\-dograb +Running under a debugger can cause an implicit \-nograb, use \-dograb +to override. +.TP +.B \-\-sync +Switches to synchronous mode for debugging. +.TP +.B \-\-fn, \-\-font \fI<fontname>\fB +Defines the application font. +.TP +.B \-\-bg, \-\-background \fI<color>\fB +Sets the default background color and an application palette (light +and dark shades are calculated). +.TP +.B \-\-fg, \-\-foreground \fI<color>\fB +Sets the default foreground color. +.TP +.B \-\-btn, \-\-button \fI<color>\fB +Sets the default button color. +.TP +.B \-\-name \fI<name>\fB +Sets the application name. +.TP +.B \-\-title \fI<title>\fB +Sets the application title (caption). +.TP +.B \-\-visual TrueColor +Forces the application to use a TrueColor visual on an 8-bit display. +.TP +.B \-\-inputstyle \fI<inputstyle>\fB +Sets XIM (X Input Method) input style. Possible values are +\fIonthespot\fP, \fIoverthespot\fP, \fIoffthespot\fP and \fIroot\fP. +.TP +.B \-\-im \fI<XIM server>\fB +Set XIM server. +.TP +.B \-\-noxim +Disable XIM. + +.SH TDE OPTIONS +.TP +.B \-\-caption \fI<caption>\fB +Use `caption' as name in the titlebar. +.TP +.B \-\-icon \fI<icon>\fB +Use `icon' as the application icon. +.TP +.B \-\-miniicon \fI<icon>\fB +Use `icon' as the icon in the titlebar. +.TP +.B \-\-dcopserver \fI<server>\fB +Use the DCOP Server specified by `server'. +.TP +.B \-\-nocrashhandler +Disable crash handler, to get core dumps. +.TP +.B \-\-waitforwm +Waits for a WM_NET compatible windowmanager. +.TP +.B \-\-style \fI<style>\fB +Sets the application GUI style. +.TP +.B \-\-geometry \fI<geometry>\fB +Sets the client geometry of the main widget. + +.SH SEE ALSO +More detailed user documentation is available from +.BR help:/kmag +(either enter this URL into \fBkonqueror\fP, or run `khelpcenter +help:/kmag'). + +.PP +There is also further information available at the +.URL https://mirror.git.trinitydesktop.org/gitea/TDE/tdeaccessibility " +tdeaccessibility project home page." + +kmag(1) + +.SH AUTHORS +.nf +OlafSchmidt <[email protected]> +.br +SarangLakare <[email protected]> +.br +MichaelForster <[email protected]> |