Mercurial > projects > xwrited

comparison data/xwrited.1.xml @ 5:f0c7f45022c0

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