diff 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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/xwrited.1.xml	Sat Jul 28 22:02:24 2018 +0200
@@ -0,0 +1,141 @@
+<?xml version="1.0"?>
+<!--
+
+Copyright (C) 2018 Guido Berhoerster <guido+xwrited@berhoerster.name>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+-->
+<refentry xmlns="http://docbook.org/ns/docbook" xml:lang="en">
+  <info>
+    <author>
+      <personname>
+        <firstname>Guido</firstname>
+        <surname>Berhoerster</surname>
+      </personname>
+      <email>guido+xwrited@berhoerster.name</email>
+      <personblurb/>
+    </author>
+    <date>29 June, 2018</date>
+  </info>
+  <refmeta>
+    <refentrytitle>xwrited</refentrytitle>
+    <manvolnum>1</manvolnum>
+    <refmiscinfo class="source"/>
+    <refmiscinfo class="version"/>
+    <refmiscinfo class="manual">User Commands</refmiscinfo>
+  </refmeta>
+  <refnamediv>
+    <refname>xwrited</refname>
+    <refpurpose>display write and wall messages as desktop
+    notifications</refpurpose>
+  </refnamediv>
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>xwrited</command>
+      <group>
+        <arg choice="plain">
+          <option>-q</option>
+        </arg>
+        <arg choice="plain">
+          <option>--quit</option>
+        </arg>
+      </group>
+      <group>
+        <arg choice="plain">
+          <option>-V</option>
+        </arg>
+        <arg choice="plain">
+          <option>--version</option>
+        </arg>
+      </group>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+  <refsect1>
+    <title>Description</title>
+    <para>The <command>xwrited</command> utility displays
+    <citerefentry><refentrytitle>write</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry> and
+    <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry> messages as desktop notifications. A notification daemon
+    compliant to the freedesktop.org Desktop Notification Specification draft
+    needs to be running in order to display the notifications.</para>
+  </refsect1>
+  <refsect1>
+    <title>Options</title>
+    <para>The following options are supported:</para>
+    <variablelist>
+      <varlistentry>
+        <term>
+          <option>-q</option>
+        </term>
+        <term>
+          <option>--quit</option>
+        </term>
+        <listitem>
+          <para>Quit the running instance of
+          <command>xwrited</command>.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <option>-V</option>
+        </term>
+        <term>
+          <option>--version</option>
+        </term>
+        <listitem>
+          <para>Print the version number and exit.</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+  <refsect1>
+    <title>Exit Status</title>
+    <para>The following exit values are returned:</para>
+    <variablelist>
+      <varlistentry>
+        <term>0</term>
+        <listitem>
+          <para>Command successfully executed.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>&gt; 0</term>
+        <listitem>
+          <para>An error has occured.</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+  <refsect1>
+    <title>See Also</title>
+    <para><citerefentry><refentrytitle>write</refentrytitle>
+    <manvolnum>1</manvolnum></citerefentry>,
+    <citerefentry> <refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></para>
+  </refsect1>
+  <refsect1>
+    <title>Notes</title>
+    <para>xwrited assumes that messages are encoded in UTF-8 because there is
+    no way for it to determine the character set encoding of the received
+    data.</para>
+  </refsect1>
+</refentry>