[Pkg-kde-commits] rev 448 - in trunk/packages/kdelibs/debian: . man
Christopher Martin
chrsmrtn-guest@costa.debian.org
Tue, 01 Feb 2005 18:52:01 +0100
Author: chrsmrtn-guest
Date: 2005-02-01 18:52:00 +0100 (Tue, 01 Feb 2005)
New Revision: 448
Modified:
trunk/packages/kdelibs/debian/changelog
trunk/packages/kdelibs/debian/man/lnusertemp.sgml
Log:
Add new manpage.
Modified: trunk/packages/kdelibs/debian/changelog
===================================================================
--- trunk/packages/kdelibs/debian/changelog 2005-01-28 16:13:10 UTC (rev 447)
+++ trunk/packages/kdelibs/debian/changelog 2005-02-01 17:52:00 UTC (rev 448)
@@ -19,6 +19,9 @@
* Also add necessary Conflicts/Replaces for old OO.org packages.
Since this is RC, urgency set to medium. (Closes: #292569)
+ * Add better manpage for lnusertemp. Thanks to Javier Fernandez-Sanguino.
+ (Closes: #292081)
+
-- Debian Qt/KDE Maintainers <debian-qt-kde@lists.debian.org> Date
kdelibs (4:3.3.2-1) unstable; urgency=medium
Modified: trunk/packages/kdelibs/debian/man/lnusertemp.sgml
===================================================================
--- trunk/packages/kdelibs/debian/man/lnusertemp.sgml 2005-01-28 16:13:10 UTC (rev 447)
+++ trunk/packages/kdelibs/debian/man/lnusertemp.sgml 2005-02-01 17:52:00 UTC (rev 448)
@@ -17,15 +17,13 @@
-->
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
- <!ENTITY dhfirstname "<firstname>Chris</firstname>">
- <!ENTITY dhsurname "<surname>Cheney</surname>">
+ <!ENTITY dhfirstname "<firstname>Javier</firstname>">
+ <!ENTITY dhsurname "<surname>Fernandez-Sanguino</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
- <!ENTITY dhdate "<date>November 6, 2002</date>">
- <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
- allowed: see man(7), man(1). -->
+ <!ENTITY dhdate "<date>25 January, 2005</date>">
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
- <!ENTITY dhemail "<email>ccheney@debian.org</email>">
- <!ENTITY dhusername "Chris Cheney">
+ <!ENTITY dhemail "<email>jfs@debian.org</email>">
+ <!ENTITY dhusername "Javier Fernandez-Sanguino">
<!ENTITY dhucpackage "<refentrytitle>LNUSERTEMP</refentrytitle>">
<!ENTITY dhpackage "lnusertemp">
@@ -43,7 +41,7 @@
&dhsurname;
</author>
<copyright>
- <year>2002</year>
+ <year>2005</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
@@ -56,13 +54,13 @@
<refnamediv>
<refname>&dhpackage;</refname>
- <refpurpose>fixme</refpurpose>
+ <refpurpose>tool to create KDE resources and symlinks to them</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
- <arg><option><replaceable>tmp|socket</replaceable></option></arg>
+ <arg><option><replaceable>tmp|socket|cache</replaceable></option></arg>
</cmdsynopsis>
</refsynopsisdiv>
@@ -72,20 +70,83 @@
<para>This manual page documents briefly the
<command>&dhpackage;</command> command.</para>
- <para><command>&dhpackage;</command> fixme.</para>
+ <para><command>&dhpackage;</command> is used to create KDE
+ resources in temporary directories and symlinks to them in
+ <envar>KDEHOME</envar>. The resource that needs to be created is
+ given as an argument and can be anyone of:</para>
+ <itemizedlist>
+
+ <listitem><para><emphasis>tmp</emphasis>: for the directory used
+ for storing temporary files. This directory should be preferably
+ on a local filesystem (available in KDE 2.x)</para> </listitem>
+
+ <listitem><para><emphasis>socket</emphasis>: for the directory
+ that holds temporary sockets. This directory needs to be on the
+ local filesystem (available in KDE 2.x)</para> </listitem>
+
+ <listitem><para><emphasis>cache</emphasis>: for the directory that
+ stores cached information such as the HTTP cache and favicons
+ (available since KDE 3.0)</para> </listitem>
+
+ </itemizedlist>
+
+ <para><command>&dhpackage;</command> will create the first two
+ resources in directories under <filename>/tmp</filename> (or
+ <envar>KDETMP</envar> if defined in the environment) and will use
+ <filename>/var/tmp</filename> (or <envar>KDEVARTMP</envar> if
+ defined in the environment) for the <emphasis>cache</emphasis>
+ resource (in order to survive system reboots). The temporary
+ directories created for resources are usually of the form
+ <filename>RESOURCE-USERNAME</filename>. The name might vary if
+ those filenames already exist and do not belong to the user for
+ which <command>&dhpackage;</command> is run, a temporary (unique)
+ name will be used if possible to prevent temporary symlink
+ attacks. </para>
+
+ <para><command>&dhpackage;</command> is usually called by the
+ <command>startkde</command> script.</para>
+
</refsect1>
<refsect1>
+ <title>EXIT VALUES</title>
+
+ <para><command>&dhpackage;</command> will return 0 if it can
+ create the resource and symlink to it, or if the resource already
+ exists and is properly symlinked it will return 1 if it cannot
+ create the link or if the symlink is pointing to an incorrect
+ location.</para>
+
+ </refsect1>
+ <refsect1>
+ <title>SEE ALSO</title>
+
+ <para>You can find more information on the KDE's usage of
+ temporary files in the Chapter <ulink
+ url="http://i18n.kde.org/doc/admin/temp-files.html"><citetitle>Temporary
+ and Other Files KDE Uses</citetitle></ulink> of the <ulink
+ url="http://i18n.kde.org/doc/admin/"><citetitle>The KDE
+ Administrators Guide</citetitle></ulink>. </para>
+
+ </refsect1>
+
+ <refsect1>
+
<title>AUTHOR</title>
- <para>This manual page was written by &dhusername; <&dhemail;> 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>
+ <para>This manual page was written by &dhusername;
+ <&dhemail;> 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 &gnu; General Public
+ License, Version 2 any later version published by the Free
+ Software Foundation. </para>
+ <para>
+ On Debian systems, the complete text of the GNU General
+ Public License can be found in
+ /usr/share/common-licenses/GPL.
+ </para>
+
</refsect1>
</refentry>