[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#742462: kde-workspace-bin: ksystraycmd has no man page



> A manpage written in docbook would be welcome,

I don't have any experience with docbook, however I found that there
used to be a man page distributed in the Debian package kdebase in
KDE 3, however it was not migrated to the KDE 4 package kde-workspace.

I have updated the old man page (attached). Perhaps it would be of
use until someone is able to write a docbook version?

--

Jim Scadden
.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand
.TH KSYSTRAYCMD 1 "November 2014" "K Desktop Environment" "system tray utility"
.SH NAME
ksystraycmd
\- Allows any application to be kept in the system tray
.SH SYNOPSIS
\fBksystraycmd\fP [Qt\-options] [KDE\-options] [options] command 
.SH DESCRIPTION
The system tray is an area in which an application can display a small window.
It may be used to display status information or provide quick access to commands.
Normally tray icons are developed as part of an application.
\fBksystraycmd\fP allows any application to be kept in the system tray.
.SH OPTIONS
.SS
.SS Arguments:
.TP
.B command
Command to execute
.SS 
.SS Options:
.TP
.B  \-\-window  <regexp>
A regular expression matching the window title.
If you do not specify one, then the very first window
to appear will be taken \- not recommended.
.TP
.B  \-\-wid  <int>
The window id of the target window. If the id starts
with 0x it is assumed to be in hex.
.TP
.B  \-\-hidden  
Hide the window to the tray on startup
.TP
.B  \-\-startonshow  
Wait until we are told to show the window before
executing the command
.TP
.B  \-\-tooltip  <text>
Sets the initial tooltip for the tray icon
.TP
.B  \-\-keeprunning  
Keep the tray icon even if the client exits. This option
has no effect unless startonshow is specified.
.TP
.B  \-\-ownicon  
Use ksystraycmd's icon instead of window's icon in systray
(should be used with \-\-icon to specify ksystraycmd icon)
.TP
.B  \-\-ontop  
Try to keep the window above other windows
.TP
.B  \-\-quitonhide  
Quit the client when we are told to hide the window.
This has no effect unless startonshow is specified and implies keeprunning.
.SS Generic options:
.TP
.B  \-\-help  
Show help about options
.TP
.B  \-\-help\-qt  
Show Qt specific options
.TP
.B  \-\-help\-kde  
Show KDE specific options
.TP
.B  \-\-help\-all  
Show all options
.TP
.B  \-\-author  
Show author information
.TP
.B \-v,  \-\-version  
Show version information
.TP
.B  \-\-license  
Show license information
.TP
.B  \-\-  
End of options
.SS 
.SS Qt options:
.TP
.B  \-\-display  <displayname>
Use the X\-server display 'displayname'
.TP
.B  \-\-session  <sessionId>
Restore the application for the given 'sessionId'
.TP
.B  \-\-cmap  
Causes the application to install a private color
map on an 8\-bit display
.TP
.B  \-\-ncols  <count>
Limits the number of colors allocated in the color
cube on an 8\-bit display, if the application is
using the QApplication::ManyColor color
specification
.TP
.B  \-\-nograb  
tells Qt to never grab the mouse or the keyboard
.TP
.B  \-\-dograb  
running under a debugger can cause an implicit
\-\-nograb, use \-\-dograb to override
.TP
.B  \-\-sync  
switches to synchronous mode for debugging
.TP
.B \-\-fn,  \-\-font  <fontname>
defines the application font
.TP
.B \-\-bg,  \-\-background  <color>
sets the default background color and an
application palette (light and dark shades are
calculated)
.TP
.B \-\-fg,  \-\-foreground  <color>
sets the default foreground color
.TP
.B \-\-btn,  \-\-button  <color>
sets the default button color
.TP
.B  \-\-name  <name>
sets the application name
.TP
.B  \-\-title  <title>
sets the application title (caption)
.TP
.B  \-\-testability
load the testability framework
.TP
.B  \-\-visual  TrueColor
forces the application to use a TrueColor visual on
an 8\-bit display
.TP
.B  \-\-inputstyle  <inputstyle>
sets XIM (X Input Method) input style. Possible
values are onthespot, overthespot, offthespot and
root
.TP
.B  \-\-im  <XIM server>
set XIM server
.TP
.B  \-\-noxim  
disable XIM
.TP
.B  \-\-reverse  
mirrors the whole layout of widgets
.TP
.B  \-\-stylesheet <file.qss>
applies the Qt stylesheet to the application widgets
.TP
.B  \-\-graphicssystem <system>
use a different graphics system instead of the default
one, options are raster and opengl (experimental)
.B  \-\-qmljsdebugger <port>
QML  JS  debugger  information.  Application  must be built with
-DQT_DECLARATIVE_DEBUG for the debugger to be enabled
.SS 
.SS KDE options:
.TP
.B  \-\-caption  <caption>
Use 'caption' as name in the titlebar
.TP
.B  \-\-icon  <icon>
Use 'icon' as the application icon
.TP
.B  \-\-config  <filename>
Use alternative configuration file
.TP
.B  \-\-nocrashhandler  
Disable crash handler, to get core dumps
.TP
.B  \-\-waitforwm  
Waits for a WM_NET compatible windowmanager
.TP
.B  \-\-style  <style>
sets the application GUI style
.TP
.B  \-\-geometry  <geometry>
sets the client geometry of the main widget - see man X for the argument format
.SS 

.SH AUTHORS
.nf
Richard Moore <rich@kde.org>
.br

.br
.fi
Please use http://bugs.kde.org to report bugs; do not mail the author directly.
.PP
This manual page was written by Holger Hartmann <Holger_Hartmann@gmx.de> for the Debian Project,
and updated by Jim Scadden <jims@silentasylum.co.uk>, but may be used by others.
Permission is granted to copy, distribute and/or modify this document under the terms of the
GNU General Public License, Version 2 or any later version published by the Free Software Foundation.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common\-licenses/GPL.

Reply to: