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