diff options
Diffstat (limited to 'doc/kdelibs')
| -rw-r--r-- | doc/kdelibs/Makefile.am | 5 | ||||
| -rw-r--r-- | doc/kdelibs/man-artsmessage.1.docbook | 92 | ||||
| -rw-r--r-- | doc/kdelibs/man-checkXML.1.docbook | 42 | ||||
| -rw-r--r-- | doc/kdelibs/man-dcop.1.docbook | 161 | ||||
| -rw-r--r-- | doc/kdelibs/man-kbuildsycoca.8.docbook | 221 | ||||
| -rw-r--r-- | doc/kdelibs/man-kdeoptions.7.docbook | 88 | ||||
| -rw-r--r-- | doc/kdelibs/man-qtoptions.7.docbook | 223 |
7 files changed, 832 insertions, 0 deletions
diff --git a/doc/kdelibs/Makefile.am b/doc/kdelibs/Makefile.am new file mode 100644 index 000000000..a95ec29b3 --- /dev/null +++ b/doc/kdelibs/Makefile.am @@ -0,0 +1,5 @@ +KDE_LANG = en +KDE_MANS = AUTO +KDE_XSL_MAN_STYLESHEET = $(top_srcdir)/kdoctools/customization/kde-man.xsl + +KDE_DOCS_DEPS = $(MEINPROC_DEP) diff --git a/doc/kdelibs/man-artsmessage.1.docbook b/doc/kdelibs/man-artsmessage.1.docbook new file mode 100644 index 000000000..f7ccb9a28 --- /dev/null +++ b/doc/kdelibs/man-artsmessage.1.docbook @@ -0,0 +1,92 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY % English "INCLUDE"> +]> + + +<refentry lang="&language;"> + <refentryinfo> + <author> + <personname><firstname>Chris</firstname><surname>Cheney</surname></personname> + <email>ccheney@debian.org</email></author> + <date>2003-03-07</date> + </refentryinfo> + + <refmeta> + <refentrytitle><command>artsmessage</command></refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname><command>artsmessage</command></refname> + <refpurpose>Utility to display &arts; error messages</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>artsmessage</command> + <group><option>&kde; generic options</option></group> + <group><option>&Qt; generic options</option></group> + <group choice="opt"> + <option>-e, --error</option><option>-w, + --warning</option><option>-i,--info</option> + </group> + <arg><replaceable>message</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + <para><command>artsmessage</command> is a utility to display &arts; error messages.</para> + </refsect1> + <refsect1> + <title>Options</title> + + <para><command>artsmessage</command> accepts the standard &Qt; and &kde; + command-line options.</para> + + + </refsect1> + + <refsect1> + <title>Application Options</title> + + <variablelist> + <varlistentry> + <term><option>-e</option>, <option>--error</option> + </term> + <listitem> + <para>Display error message (default).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>-i</option>, <option>--info</option> + </term> + <listitem> + <para>Display informational message.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>-w</option>, <option>--warning</option> + </term> + <listitem> + <para>Display warning message.</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1> + + <title>Author</title> + + <para>This manual page was written by <personname><firstname>Chris</firstname><surname>Cheney</surname></personname><email>ccheney@debian.org</email> for + the Debian system (but may be used by others). Permission is + granted to copy, distribute and/or modify this document under + the terms of the <acronym>GNU</acronym> Free Documentation + License, Version 1.1 or any later version published by the Free + Software Foundation; with no Invariant Sections, no Front-Cover + Texts and no Back-Cover Texts.</para> + + </refsect1> +</refentry> + diff --git a/doc/kdelibs/man-checkXML.1.docbook b/doc/kdelibs/man-checkXML.1.docbook new file mode 100644 index 000000000..a083c4739 --- /dev/null +++ b/doc/kdelibs/man-checkXML.1.docbook @@ -0,0 +1,42 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<author><personname><firstname>Lauri</firstname><surname>Watts</surname></personname><email>lauri@kde.org</email></author> +<date>2003-07-03</date> +</refentryinfo> + +<refmeta> +<refentrytitle><command>checkXML</command></refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>checkXML</command></refname> +<refpurpose>An &XML; lint tool for &kde; DocBook &XML; documents.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>checkXML</command> <arg><replaceable>filename</replaceable></arg> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>Description</title> + +<para><command>checkXML</command> is a tool to check for syntax errors in &kde; +DocBook &XML; files. It can also be used for other DocBook based +&XML; files, but you should use the less specific xmllint(1) tool if +you are not writing or otherwise working on &kde; +documentation.</para> +</refsect1> + +<refsect1> +<title>See Also</title> +<para>meinproc(1) xmllint(1)</para> +</refsect1> +</refentry>
\ No newline at end of file diff --git a/doc/kdelibs/man-dcop.1.docbook b/doc/kdelibs/man-dcop.1.docbook new file mode 100644 index 000000000..ba200e09b --- /dev/null +++ b/doc/kdelibs/man-dcop.1.docbook @@ -0,0 +1,161 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY kdeoptions SYSTEM "kdeoptions.docbook"> +<!ENTITY qtoptions SYSTEM "qtoptions.docbook"> +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<author><personname><firstname>Chris</firstname><surname>Cheney</surname></personname> +<email>ccheney@debian.org</email></author> +<date>March 7, 2003</date> +</refentryinfo> + +<refmeta> +<refentrytitle><command>dcop</command></refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>dcop</command></refname> +<refpurpose>Console &DCOP; client</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>dcop</command> +<group><option>--pipe</option></group> +<group><option>--user</option> <replaceable> user</replaceable></group> +<group><option>--all-users</option></group> +<group><option>--session</option> <replaceable> session</replaceable></group> +<group><option>--all-sessions</option></group> +<group><option>--list-sessions</option></group> +<group><option>--no-user-time</option></group> +<group> + <arg><replaceable>application</replaceable></arg> + <group> + <arg><replaceable>object</replaceable></arg> + <group> + <arg choice="opt"><replaceable>function</replaceable></arg> +<group><arg choice="opt" rep="repeat"><replaceable>arguments</replaceable></arg></group> +</group> +</group> +</group> +</cmdsynopsis> + +</refsynopsisdiv> + +<refsect1> +<title>Description</title> +<para>Console &DCOP; client</para> + +<para><!-- Write some stuff here --></para> + +</refsect1> + +<refsect1> +<title>Options</title> + +<variablelist> +<varlistentry> +<term><option>--pipe</option></term> +<listitem> +<para>Call &DCOP; for each line read from stdin.</para> +<para>This is roughly equivalent to calling <userinput>while read line +; do dcop $line ; done</userinput> but because no new +<command>dcop</command> instance has to be started for each line this +is generally much faster, especially for the slower GNU dynamic +linkers.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--user</option> <replaceable>user</replaceable></term> +<listitem> +<para>Connect to the given user's &DCOP; server. This option will +ignore the values of the environment vars $<envar>DCOPSERVER</envar> +and $<envar>ICEAUTHORITY</envar>, even if they are set.</para> +<para>If the user has more than one open session, you must also use +one of the <option>--list-sessions</option>, +<option>--session</option> or <option>--all-sessions</option> +command-line options.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--all-users</option></term> +<listitem> +<para>Send the same &DCOP; call to all users with a running &DCOP; +server. Only failed calls to existing &DCOP; servers will generate an +error message. If no &DCOP; server is available at all, no error will +be generated.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--session</option> +<replaceable>session</replaceable></term> +<listitem><para>Send to the given &kde; session. This option can only +be used in combination with the <option>--user</option> option.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--all-sessions</option></term> +<listitem> +<para>Send to all sessions found. Only works with the +<option>--user</option> and <option>--all-users</option> +options.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--list-sessions</option></term> +<listitem> +<para>List all active &kde; sessions for a user or all users.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--no-user-time</option></term> +<listitem> +<para>Don't update the user activity timestamp in the called application (for use in scripts running in the background).</para> +</listitem></varlistentry> +</variablelist> +</refsect1> + +<refsect1> +<title>Environment</title> + +<variablelist> +<varlistentry> +<term><envar>DCOPSERVER</envar></term> +<listitem> +<para><!-- What does this tell dcop? --></para> +</listitem> +</varlistentry> +<varlistentry> +<term><envar>ICEAUTHORITY</envar></term> +<listitem><para><!-- What does this tell dcop? --></para> +</listitem> +</varlistentry> +</variablelist> +</refsect1> + +<!-- +<refsect1> +<title>Examples</title> + +<para>Write some examples</para> + +</refsect1> +--> +<refsect1> +<title>See Also</title> + +<para>dcopclient(1) dcopref(1) dcopfind(1) kdcop(1)</para> + +<para>Inside &kde;, you can enter <userinput>help:/kdcop</userinput> +in &konqueror; to see the User Manual for +<application>kdcop</application> graphical dcop tool.</para> + +<!-- +<para> Info on where to find proper dcop docs </para> +--> +</refsect1> +</refentry> diff --git a/doc/kdelibs/man-kbuildsycoca.8.docbook b/doc/kdelibs/man-kbuildsycoca.8.docbook new file mode 100644 index 000000000..1105f8e48 --- /dev/null +++ b/doc/kdelibs/man-kbuildsycoca.8.docbook @@ -0,0 +1,221 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.1-Based Variant V1.0//EN" "dtd/kdex.dtd" [ + <!ENTITY % English "INCLUDE"><!-- change language only here --> +]> + +<refentry> + +<refentryinfo> + +<author> +<firstname>Darian</firstname> +<surname>Lanx</surname> +<affiliation> +<address><email>content@openprojects.net</email></address> +</affiliation> +</author> + +<date>2001-04-25</date> +<releaseinfo>0.01.01</releaseinfo> + +</refentryinfo> + +<refmeta> +<refentrytitle>KBuildSycoca</refentrytitle> +<manvolnum>8</manvolnum> +</refmeta> + +<refnamediv> +<refname>Description</refname> +<refpurpose>Rebuilds the system configuration cache.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<title>Synopsis</title> + +<cmdsynopsis> +<command>kbuildsycoca</command> + +<group> +<arg choice="opt">--nosignal</arg> +<arg choice="opt">--incremental</arg> +<arg choice="opt">--help</arg> +<arg choice="opt">--help-qt</arg> +<arg choice="opt">--help-kde</arg> +<arg choice="opt">--help-all</arg> +<arg choice="opt">--author</arg> +<arg choice="opt">-v, --version</arg> +<arg choice="opt">--license</arg> +</group> +</cmdsynopsis> + +</refsynopsisdiv> + +<refsect1> +<title>Description</title> + +<para> +<command>kbuildsyscoca</command>, as part of the &kde; command line +tools ensures the proper operation of &kde; by reading in all the +<literal role="extension">.desktop</literal>, <literal +role="extension">.directory</literal>, <literal +role="extension">.kimgio</literal> and <literal +role="extension">.protocol</literal> files to constructs a binary +database. +</para> + +<para> +&kde; itself accesses this databse during operation to provide +configurational information a program needs to run. +</para> + +<para> +This tool is part of ksyscoca, which stands for &kde; System +Configuration Cache +</para> + +</refsect1> + +<refsect1> +<title>Options</title> + +<variablelist> +<varlistentry> +<term><option>--nosignal</option></term> +<listitem> +<para>Don't signal applications </para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--incremental</option></term> +<listitem> +<para>Incremental Update</para> +</listitem> +</varlistentry> + +<!-- this entire section from here to the end of the section could be an --> +<!-- entity.. or maybe just so irrelevant as to leave it out --> + +<varlistentry> +<term><option>--help</option></term> +<listitem> +<para> +Show help about options +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--help-qt</option></term> +<listitem> +<para> +Show Qt specific options +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--help-kde</option></term> +<listitem> +<para> +Show KDE specific options +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--help-all</option></term> +<listitem> +<para> +Show all options +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--author</option></term> +<listitem> +<para> +Show author information +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--version</option></term> +<listitem> +<para> +Show version information +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--license</option></term> +<listitem> +<para> +Show license information +</para> +</listitem> +</varlistentry> +</variablelist> + +</refsect1> + +<refsect1> +<title>Usage</title> +<para> +A standard way to run this program is by simply specifying the following +command at the prompt +<userinput><command>kbuildsyscoca</command></userinput> +</para> + +</refsect1> + +<refsect1> +<title>Files</title> + +<variablelist> +<varlistentry> +<term><filename>/tmp/kde-$USER/ksyscoca</filename></term> +<listitem> +<para>...</para> +</listitem> +</varlistentry> +</variablelist> + +</refsect1> + +<refsect1> +<title>Environment Variables</title> +<variablelist> +<varlistentry> +<term>$<envar>KDEDIRS</envar></term> +<listitem> +<para>Specifies which directories are part of the KDE +installations</para> +</listitem> +</varlistentry> +</variablelist> + +</refsect1> + +<refsect1> +<title>See Also</title> + +<para>ksycoca(3), kblah(4), knogga(6)</para> + +</refsect1> + +<refsect1> +<title>Bugs</title> + +<para>There are no known bugs at the time of writing.</para> + +</refsect1> + +</refentry> + + + diff --git a/doc/kdelibs/man-kdeoptions.7.docbook b/doc/kdelibs/man-kdeoptions.7.docbook new file mode 100644 index 000000000..248daa5e0 --- /dev/null +++ b/doc/kdelibs/man-kdeoptions.7.docbook @@ -0,0 +1,88 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<title>KDE User's Manual</title> +<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<date>2004-02-02</date> +<productname>K Desktop Environment</productname> +</refentryinfo> + +<refmeta> +<refentrytitle>kdeoptions</refentrytitle> +<manvolnum>7</manvolnum> +</refmeta> + +<refnamediv> +<refname>KDE options</refname> +<refpurpose>Common commandline options for all applications based on the KDE libraries</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command><replaceable>KDE application</replaceable></command> +<arg choice="opt">KDE Generic Options</arg> +</cmdsynopsis> +</refsynopsisdiv> + + +<refsect1> +<title>Options</title> + +<para>The following options apply to all &kde; applications:</para> + + +<para>The following options apply to all &kde; applications:</para> +<variablelist> +<varlistentry> +<term><option>--caption</option> <parameter>caption</parameter></term> +<listitem><para>Use <parameter>caption</parameter> as name in the +titlebar.</para></listitem> +</varlistentry> +<varlistentry> +<term><option>--icon</option> <parameter>icon</parameter></term> +<listitem><para>Use <parameter>icon</parameter> as the application icon.</para></listitem> +</varlistentry> +<varlistentry> +<term><option>--miniicon</option> <parameter>icon</parameter></term> +<listitem><para>Use <parameter>icon</parameter> as the icon in the titlebar</para></listitem> +</varlistentry> +<varlistentry> +<term><option>--dcopserver</option> <parameter>server</parameter></term> +<listitem><para>Use the <acronym>DCOP</acronym> Server specified by <parameter>server</parameter>.</para></listitem> +</varlistentry> +<varlistentry> +<term><option>--nocrashhandler</option></term> +<listitem><para>Disable the crash handler, to get core dumps.</para></listitem> +</varlistentry> +<varlistentry> +<term><option>--waitforwm</option></term> +<listitem><para>Waits for a WM_NET compatible windowmanager.</para></listitem> +</varlistentry> +<varlistentry> +<term><option>--style</option> <parameter>style</parameter></term> +<listitem><para>Sets the appliction &GUI; style.</para></listitem> +</varlistentry> +<varlistentry> +<term><option>--geometry</option> <parameter>geometry</parameter></term> +<listitem><para>Sets the client geometry of the main widget.</para></listitem> +</varlistentry> +</variablelist> + +</refsect1> + +<refsect1> +<title>See Also</title> +<para>qtoptions.7</para> + +</refsect1> + +<refsect1> +<title>Authors</title> +<para>Man page written by &Lauri.Watts; &Lauri.Watts.mail;</para> +</refsect1> + +</refentry>
\ No newline at end of file diff --git a/doc/kdelibs/man-qtoptions.7.docbook b/doc/kdelibs/man-qtoptions.7.docbook new file mode 100644 index 000000000..b6ce61dc6 --- /dev/null +++ b/doc/kdelibs/man-qtoptions.7.docbook @@ -0,0 +1,223 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<title>KDE User's Manual</title> +<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<date>2004-02-02</date> +<productname>K Desktop Environment</productname> +</refentryinfo> + +<refmeta> +<refentrytitle>qtoptions</refentrytitle> +<manvolnum>7</manvolnum> +</refmeta> + +<refnamediv> +<refname>Qt options</refname> +<refpurpose>Common commandline options for all applications based on the Qt toolkit</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command><replaceable>Qt application</replaceable></command> +<arg choice="opt">Qt Generic Options</arg> +</cmdsynopsis> +</refsynopsisdiv> + + +<refsect1> +<title>Options</title> + +<para>The following options apply to all &Qt; applications:</para> + +<variablelist> <!-- all this could be entitiesan entity --> +<varlistentry> +<term> +<option>--display</option> <parameter>displayname</parameter> +</term> +<listitem> +<para>Use the X-server display +<parameter>displayname</parameter>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<option>--session</option> <parameter>sessionId</parameter> +</term> +<listitem> +<para>Restore the application for the given +<parameter>sessionId</parameter>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<option>--cmap</option> +</term> +<listitem> +<para>Causes the application to install a private color map on an +8-bit display.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<option>--ncols</option> <parameter>count</parameter> +</term> +<listitem> +<para>Limits the number of colors allocated in the color cube on an +8-bit display, if the application is using the +<methodname>QApplication::ManyColor</methodname> color +specification.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<option>--nograb</option> +</term> +<listitem> +<para>Tells &Qt; to never grab the mouse or the keyboard.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<option>--dograb</option> +</term> +<listitem> +<para>Running under a debugger can cause an implicit +<option>--nograb</option>, use <option>--dograb</option> to +override.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<option>--sync</option> +</term> +<listitem> +<para>Switches to synchronous mode for debugging.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<option>--fn</option>,<option>--font</option> +<parameter>fontname</parameter> +</term> +<listitem> +<para>Defines the application font.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<option>--bg</option>,<option>--background</option> +<parameter>color</parameter> +</term> +<listitem> +<para>Sets the default background color and an application palette +(light and dark shades are calculated).</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<option>--fg</option>,<option>--foreground</option> +<parameter>color</parameter> +</term> +<listitem> +<para>Sets the default foreground color</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<option>--btn</option>,<option>--button</option> +<parameter>color</parameter> +</term> +<listitem> +<para>Sets the default button color.</para> +</listitem> +</varlistentry> + + +<varlistentry> +<term> +<option>--name</option> <parameter>name</parameter> +</term> +<listitem> +<para>Sets the application name.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<option>--title</option> <parameter>title</parameter> +</term> +<listitem> +<para>Sets the application title (caption).</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<option>--visual</option> <parameter>TrueColor</parameter> +</term> +<listitem> +<para>Forces the application to use a <parameter>TrueColor</parameter> +visual on an 8-bit display.</para> +</listitem> +</varlistentry> + + +<varlistentry> +<term> +<option>--inputstyle</option> <parameter>inputstyle</parameter> +</term> +<listitem> +<para>Sets XIM (X Input Method) input style. Possible values are +<parameter>onthespot</parameter>, <parameter>overthespot</parameter>, +<parameter>offthespot</parameter> and +<parameter>root</parameter>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<option>--im</option> <parameter>XIM server</parameter> +</term> +<listitem> +<para>Set XIM server.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<option>--noxim</option> +</term> +<listitem> +<para>Disable XIM</para> +</listitem> +</varlistentry> +</variablelist> +</refsect1> + +<refsect1> +<title>See Also</title> +<para>kde-options.7</para> + +</refsect1> + +<refsect1> +<title>Authors</title> +<para>Man page written by &Lauri.Watts; &Lauri.Watts.mail;</para> +</refsect1> + +</refentry> |