Mercurial > projects > xwrited
annotate xwrited.1.xml @ 19:f0accfc74f7b
Port to GLib version 2.48 or later
Use GApplication instead of the custom XWritedUnique object for uniqueness.
Use GNotification from GIO instead of libnotify.
Remove help and debug options from documentation.
Replace intltool with GNU gettext (version 0.19 or later required).
| author | Guido Berhoerster <guido+xwrited@berhoerster.name> |
|---|---|
| date | Sat, 28 Jul 2018 22:02:24 +0200 |
| parents | data/xwrited.1.xml@f088694c1c32 |
| children |
| rev | line source |
|---|---|
| 5 | 1 <?xml version="1.0"?> |
| 2 <!-- | |
| 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 | 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> | |
|
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 | 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> | |
|
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 | 69 </cmdsynopsis> |
| 70 </refsynopsisdiv> | |
| 71 <refsect1> | |
| 72 <title>Description</title> | |
| 73 <para>The <command>xwrited</command> utility displays | |
| 74 <citerefentry><refentrytitle>write</refentrytitle><manvolnum>1</manvolnum> | |
| 75 </citerefentry> and | |
| 76 <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum> | |
| 77 </citerefentry> messages as desktop notifications. A notification daemon | |
| 78 compliant to the freedesktop.org Desktop Notification Specification draft | |
| 79 needs to be running in order to display the notifications.</para> | |
| 80 </refsect1> | |
| 81 <refsect1> | |
| 82 <title>Options</title> | |
| 83 <para>The following options are supported:</para> | |
| 84 <variablelist> | |
| 85 <varlistentry> | |
| 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 | 88 </term> |
| 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 | 91 </term> |
| 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 | 95 </listitem> |
| 96 </varlistentry> | |
| 97 <varlistentry> | |
| 98 <term> | |
| 99 <option>-V</option> | |
| 100 </term> | |
| 101 <term> | |
| 102 <option>--version</option> | |
| 103 </term> | |
| 104 <listitem> | |
| 105 <para>Print the version number and exit.</para> | |
| 106 </listitem> | |
| 107 </varlistentry> | |
| 108 </variablelist> | |
| 109 </refsect1> | |
| 110 <refsect1> | |
| 111 <title>Exit Status</title> | |
| 112 <para>The following exit values are returned:</para> | |
| 113 <variablelist> | |
| 114 <varlistentry> | |
| 115 <term>0</term> | |
| 116 <listitem> | |
| 117 <para>Command successfully executed.</para> | |
| 118 </listitem> | |
| 119 </varlistentry> | |
| 120 <varlistentry> | |
| 121 <term>> 0</term> | |
| 122 <listitem> | |
| 123 <para>An error has occured.</para> | |
| 124 </listitem> | |
| 125 </varlistentry> | |
| 126 </variablelist> | |
| 127 </refsect1> | |
| 128 <refsect1> | |
| 129 <title>See Also</title> | |
| 130 <para><citerefentry><refentrytitle>write</refentrytitle> | |
| 131 <manvolnum>1</manvolnum></citerefentry>, | |
| 132 <citerefentry> <refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum> | |
| 133 </citerefentry></para> | |
| 134 </refsect1> | |
| 135 <refsect1> | |
| 136 <title>Notes</title> | |
| 137 <para>xwrited assumes that messages are encoded in UTF-8 because there is | |
| 138 no way for it to determine the character set encoding of the received | |
| 139 data.</para> | |
| 140 </refsect1> | |
| 141 </refentry> |