annotate xwrited.1.xml @ 23:98b5d974cea5 default tip

Added tag version-3 for changeset 9d00c0e07c47
author Guido Berhoerster <guido+xwrited@berhoerster.name>
date Sat, 30 Jun 2018 23:09:12 +0200
parents f0accfc74f7b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
1 <?xml version="1.0"?>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
2 <!--
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
3
19
f0accfc74f7b Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents: 16
diff changeset
4 Copyright (C) 2018 Guido Berhoerster <guido+xwrited@berhoerster.name>
5
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
5
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
6 Permission is hereby granted, free of charge, to any person obtaining
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
7 a copy of this software and associated documentation files (the
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
8 "Software"), to deal in the Software without restriction, including
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
9 without limitation the rights to use, copy, modify, merge, publish,
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
10 distribute, sublicense, and/or sell copies of the Software, and to
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
11 permit persons to whom the Software is furnished to do so, subject to
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
12 the following conditions:
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
13
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
14 The above copyright notice and this permission notice shall be included
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
15 in all copies or substantial portions of the Software.
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
16
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
18 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
19 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
20 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
21 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
22 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
23 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
24
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
25 -->
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
26 <refentry xmlns="http://docbook.org/ns/docbook" xml:lang="en">
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
27 <info>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
28 <author>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
29 <personname>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
30 <firstname>Guido</firstname>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
31 <surname>Berhoerster</surname>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
32 </personname>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
33 <email>guido+xwrited@berhoerster.name</email>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
34 <personblurb/>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
35 </author>
19
f0accfc74f7b Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents: 16
diff changeset
36 <date>29 June, 2018</date>
5
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
37 </info>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
38 <refmeta>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
39 <refentrytitle>xwrited</refentrytitle>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
40 <manvolnum>1</manvolnum>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
41 <refmiscinfo class="source"/>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
42 <refmiscinfo class="version"/>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
43 <refmiscinfo class="manual">User Commands</refmiscinfo>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
44 </refmeta>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
45 <refnamediv>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
46 <refname>xwrited</refname>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
47 <refpurpose>display write and wall messages as desktop
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
48 notifications</refpurpose>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
49 </refnamediv>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
50 <refsynopsisdiv>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
51 <cmdsynopsis>
16
f088694c1c32 Fix wrong command name in the manpage synopsis
Thomas Koch <thomas@koch.ro>
parents: 5
diff changeset
52 <command>xwrited</command>
19
f0accfc74f7b Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents: 16
diff changeset
53 <group>
f0accfc74f7b Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents: 16
diff changeset
54 <arg choice="plain">
f0accfc74f7b Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents: 16
diff changeset
55 <option>-q</option>
f0accfc74f7b Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents: 16
diff changeset
56 </arg>
f0accfc74f7b Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents: 16
diff changeset
57 <arg choice="plain">
f0accfc74f7b Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents: 16
diff changeset
58 <option>--quit</option>
f0accfc74f7b Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents: 16
diff changeset
59 </arg>
f0accfc74f7b Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents: 16
diff changeset
60 </group>
f0accfc74f7b Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents: 16
diff changeset
61 <group>
f0accfc74f7b Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents: 16
diff changeset
62 <arg choice="plain">
f0accfc74f7b Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents: 16
diff changeset
63 <option>-V</option>
f0accfc74f7b Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents: 16
diff changeset
64 </arg>
f0accfc74f7b Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents: 16
diff changeset
65 <arg choice="plain">
f0accfc74f7b Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents: 16
diff changeset
66 <option>--version</option>
f0accfc74f7b Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents: 16
diff changeset
67 </arg>
f0accfc74f7b Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents: 16
diff changeset
68 </group>
5
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
69 </cmdsynopsis>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
70 </refsynopsisdiv>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
71 <refsect1>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
72 <title>Description</title>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
73 <para>The <command>xwrited</command> utility displays
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
74 <citerefentry><refentrytitle>write</refentrytitle><manvolnum>1</manvolnum>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
75 </citerefentry> and
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
76 <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
77 </citerefentry> messages as desktop notifications. A notification daemon
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
78 compliant to the freedesktop.org Desktop Notification Specification draft
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
79 needs to be running in order to display the notifications.</para>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
80 </refsect1>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
81 <refsect1>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
82 <title>Options</title>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
83 <para>The following options are supported:</para>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
84 <variablelist>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
85 <varlistentry>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
86 <term>
19
f0accfc74f7b Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents: 16
diff changeset
87 <option>-q</option>
5
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
88 </term>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
89 <term>
19
f0accfc74f7b Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents: 16
diff changeset
90 <option>--quit</option>
5
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
91 </term>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
92 <listitem>
19
f0accfc74f7b Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents: 16
diff changeset
93 <para>Quit the running instance of
f0accfc74f7b Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents: 16
diff changeset
94 <command>xwrited</command>.</para>
5
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
95 </listitem>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
96 </varlistentry>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
97 <varlistentry>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
98 <term>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
99 <option>-V</option>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
100 </term>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
101 <term>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
102 <option>--version</option>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
103 </term>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
104 <listitem>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
105 <para>Print the version number and exit.</para>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
106 </listitem>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
107 </varlistentry>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
108 </variablelist>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
109 </refsect1>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
110 <refsect1>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
111 <title>Exit Status</title>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
112 <para>The following exit values are returned:</para>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
113 <variablelist>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
114 <varlistentry>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
115 <term>0</term>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
116 <listitem>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
117 <para>Command successfully executed.</para>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
118 </listitem>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
119 </varlistentry>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
120 <varlistentry>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
121 <term>&gt; 0</term>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
122 <listitem>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
123 <para>An error has occured.</para>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
124 </listitem>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
125 </varlistentry>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
126 </variablelist>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
127 </refsect1>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
128 <refsect1>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
129 <title>See Also</title>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
130 <para><citerefentry><refentrytitle>write</refentrytitle>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
131 <manvolnum>1</manvolnum></citerefentry>,
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
132 <citerefentry> <refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
133 </citerefentry></para>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
134 </refsect1>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
135 <refsect1>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
136 <title>Notes</title>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
137 <para>xwrited assumes that messages are encoded in UTF-8 because there is
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
138 no way for it to determine the character set encoding of the received
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
139 data.</para>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
140 </refsect1>
f0c7f45022c0 Add manpage
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff changeset
141 </refentry>