Panel/doc/panel-embed.xml.in
Pierre Pronchery 14dfb99a81 doc: use config.ent
While there, also update the license, the copyright information, and
consistently link to the project's homepage.
2024-12-05 00:08:06 +01:00

115 lines
3.4 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Id$ -->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY firstname "Pierre">
<!ENTITY surname "Pronchery">
<!ENTITY email "khorben@defora.org">
<!ENTITY section "1">
<!ENTITY title "Panel User Manual">
<!ENTITY name "panel-embed">
<!ENTITY purpose "Helper for the embedding Panel applet">
<!ENTITY % configentities SYSTEM "../config.ent">
%configentities;
]>
<refentry>
<refentryinfo>
<title>&title;</title>
<date>@DATE@</date>
<productname>&package;</productname>
<authorgroup>
<author>
<firstname>&firstname;</firstname>
<surname>&surname;</surname>
<contrib>Code and documentation.</contrib>
<address>
<email>&email;</email>
</address>
</author>
</authorgroup>
<copyright>
<year>2012</year>
<year>2013</year>
<year>2014</year>
<year>2015</year>
<year>2016</year>
<year>2017</year>
<year>2018</year>
<year>2019</year>
<year>2020</year>
<year>2021</year>
<year>2022</year>
<year>2023</year>
<year>2024</year>
<holder>&firstname; &surname; &lt;&email;&gt;</holder>
</copyright>
<legalnotice>
<para>This manual page was written for the DeforaOS
project (and may be used by others).</para>
<para>Permission is granted to copy, distribute and/or
modify this document under the terms of the
Creative Commons Attribution 4.0 International
license.</para>
</legalnotice>
</refentryinfo>
<refmeta>
<refentrytitle>&name;</refentrytitle>
<manvolnum>&section;</manvolnum>
</refmeta>
<refnamediv>
<refname>&name;</refname>
<refpurpose>&purpose;</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&name;</command>
<arg choice="plain"><replaceable>command</replaceable></arg>
<arg choice="optional" rep="repeat"><replaceable>argument</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>Description</title>
<para><command>&name;</command> is a helper program for the embedding Panel
applet. It automatically embeds the child program inside the Panel, provided
this program prints out the XID of the window to embed in a single line, on
its standard output stream.</para>
</refsect1>
<refsect1 id="options">
<title>Options</title>
<para><command>&name;</command> expects the name of a command, along with its
optional parameters to be specified as arguments on the command line.</para>
</refsect1>
<refsect1 id="bugs">
<title>Bugs</title>
<para>Issues can be listed and reported at <ulink
url="https://www.defora.org/os/project/bug_list/3262/Panel"/>.</para>
</refsect1>
<refsect1 id="see_also">
<title>See also</title>
<para>
<citerefentry>
<refentrytitle>panel</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>panelctl</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>panel-message</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>panel-notify</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
</para>
<refsect2>
<title>Additional resources</title>
<para>More information can be found on the project page at <ulink
url="https://www.defora.org/os/project/3262/Panel"/>.</para>
</refsect2>
</refsect1>
</refentry>
<!-- vim: set noet ts=1 sw=1 sts=1 tw=80: -->