Bug#359097: kdelibs-bin: no man pages for dcopstart and dcopfind
* Christopher Martin <chrsmrtn@debian.org> [060328 18:30]:
> On Sunday 26 March 2006 11:02, Johannes Ranke wrote:
> > Package: kdelibs-bin
> > Version: 4:3.5.1-3
> > Severity: minor
> > Tags: patch
> >
> > Attached you find two man pages for these small but potentially
> > useful applications. There are some more commands without a man page,
> > but I don't use them.
>
> Thank you for the manpages. I see that they are licensed under the GFDL.
> Since you don't allow Invariant Sections, etc., they are technically
> suitable for being shipped in Debian. However, the GFDL is still a
> problematic license, and we try to avoid it as much as possible. Would
> you be willing to relicense your manpages under the GPL? Most of our
> manpages are under that license already. Sorry for the hassle.
Never mind. I appreciate that the Debian projects makes a strong effort
to achieve good licensing. In preparing the attached revisions, I
noticed that there is a typo in (all?) of the other man pages in
kdelibs-bin - I am sure it should be "...Version 2 or any later
version..." ^^
Johannes
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Process this file with docbook-to-man to generate an nroff manual
page: `docbook-to-man manpage.sgml > manpage.1'. You may view
the manual page with: `docbook-to-man manpage.sgml | nroff -man |
less'. A typical entry in a Makefile or Makefile.am is:
manpage.1: manpage.sgml
docbook-to-man $< > $@
The docbook-to-man binary is found in the docbook-to-man package.
Please remember that if you create the nroff version in one of the
debian/rules file targets (such as build), you will need to include
docbook-to-man in your Build-Depends control field.
-->
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "<firstname>Johannes</firstname>">
<!ENTITY dhsurname "<surname>Ranke</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>March 25, 2006</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>jranke@uni-bremen.de</email>">
<!ENTITY dhusername "Johannes Ranke">
<!ENTITY dhucpackage "<refentrytitle>DCOPFIND</refentrytitle>">
<!ENTITY dhpackage "dcopfind">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
]>
<refentry>
<refentryinfo>
<address>
&dhemail;
</address>
<author>
&dhfirstname;
&dhsurname;
</author>
<copyright>
<year>2006</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>Find the DCOP reference of a KDE service</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg><option>-a</option></arg>
<arg><option>-l</option></arg>
<arg choice='req'><replaceable>service</replaceable></arg>
<arg><replaceable>object</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>&dhpackage;</command> returns a reference to the first
instance of the KDE service specified by
<replaceable>service</replaceable>. See also dcopstart, which starts a
service/application and immediately returns its reference.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term><option>-a</option>
</term>
<listitem>
<para>Print the application id. Without this argument, the
application id will be returned in the form
DCOPRef(application id,object id).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-l</option>
</term>
<listitem>
<para>If the object is not found, run dcopstart and try again.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--help</option>
</term>
<listitem>
<para>Show usage information.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<para><example>
<title>Return reference to a Kate instance</title>
<blockquote><literallayout>
KATE=`dcopfind -a 'kate-*'`
</literallayout></blockquote>
</example></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
&gnu; General Public License, Version 2 or 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>
<refsect1>
<title>SEE ALSO</title>
<para><application>dcopstart</application>(1), <application>dcop</application>(1)</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Process this file with docbook-to-man to generate an nroff manual
page: `docbook-to-man manpage.sgml > manpage.1'. You may view
the manual page with: `docbook-to-man manpage.sgml | nroff -man |
less'. A typical entry in a Makefile or Makefile.am is:
manpage.1: manpage.sgml
docbook-to-man $< > $@
The docbook-to-man binary is found in the docbook-to-man package.
Please remember that if you create the nroff version in one of the
debian/rules file targets (such as build), you will need to include
docbook-to-man in your Build-Depends control field.
-->
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "<firstname>Johannes</firstname>">
<!ENTITY dhsurname "<surname>Ranke</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>March 25, 2006</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>jranke@uni-bremen.de</email>">
<!ENTITY dhusername "Johannes Ranke">
<!ENTITY dhucpackage "<refentrytitle>DCOPSTART</refentrytitle>">
<!ENTITY dhpackage "dcopstart">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
]>
<refentry>
<refentryinfo>
<address>
&dhemail;
</address>
<author>
&dhfirstname;
&dhsurname;
</author>
<copyright>
<year>2006</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>Start a KDE service and return its DCOP reference</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg choice='req'><replaceable>service</replaceable></arg>
<arg><replaceable>...</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>&dhpackage;</command> starts a KDE service (i.e. an application
that is registered in the KDE system of .desktop files) and returns its
reference for later use in shell scripts. If the service is not scriptable
via DCOP, dcopstart returns nothing, but starts the service.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term><option>--help</option>
</term>
<listitem>
<para>Show usage information.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<para><example>
<title>Get the DCOP reference for a newly started konqueror instance</title>
<blockquote><literallayout>
KONQ_ID=$(dcopstart konqueror http://www.kde.org)
</literallayout></blockquote>
</example></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
&gnu; General Public License, Version 2 or 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>
<refsect1>
<title>SEE ALSO</title>
<para><application>dcop</application>(1), <application>dcopfind</application>(1)</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
Reply to: