projects/pwm

diff pwm-clip.1.xml @ 26:5bdea77d0c1d

Add pwm-clip utility for setting the X11 CLIPBOARD selection
author Guido Berhoerster <guido+pwm@berhoerster.name>
date Thu Sep 21 09:45:59 2017 +0200 (2017-09-21)
parents
children
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/pwm-clip.1.xml	Thu Sep 21 09:45:59 2017 +0200
     1.3 @@ -0,0 +1,120 @@
     1.4 +<?xml version="1.0"?>
     1.5 +<!--
     1.6 +
     1.7 +Copyright (C) 2017 Guido Berhoerster <guido+pwm@berhoerster.name>
     1.8 +
     1.9 +Permission is hereby granted, free of charge, to any person obtaining
    1.10 +a copy of this software and associated documentation files (the
    1.11 +"Software"), to deal in the Software without restriction, including
    1.12 +without limitation the rights to use, copy, modify, merge, publish,
    1.13 +distribute, sublicense, and/or sell copies of the Software, and to
    1.14 +permit persons to whom the Software is furnished to do so, subject to
    1.15 +the following conditions:
    1.16 +
    1.17 +The above copyright notice and this permission notice shall be included
    1.18 +in all copies or substantial portions of the Software.
    1.19 +
    1.20 +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    1.21 +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    1.22 +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
    1.23 +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
    1.24 +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
    1.25 +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
    1.26 +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
    1.27 +
    1.28 +-->
    1.29 +<refentry xmlns="http://docbook.org/ns/docbook" xml:lang="en">
    1.30 +  <info>
    1.31 +    <author>
    1.32 +      <personname>
    1.33 +        <firstname>Guido</firstname>
    1.34 +        <surname>Berhoerster</surname>
    1.35 +      </personname>
    1.36 +      <email>guido+pwm@berhoerster.name</email>
    1.37 +      <personblurb/>
    1.38 +    </author>
    1.39 +    <date>21 September, 2017</date>
    1.40 +  </info>
    1.41 +  <refmeta>
    1.42 +    <refentrytitle>pwm-clip</refentrytitle>
    1.43 +    <manvolnum>1</manvolnum>
    1.44 +    <refmiscinfo class="source"/>
    1.45 +    <refmiscinfo class="version"/>
    1.46 +    <refmiscinfo class="manual">User Commands</refmiscinfo>
    1.47 +  </refmeta>
    1.48 +  <refnamediv>
    1.49 +    <refname>pwm-clip</refname>
    1.50 +    <refpurpose>set the system clipboard</refpurpose>
    1.51 +  </refnamediv>
    1.52 +  <refsynopsisdiv>
    1.53 +    <cmdsynopsis>
    1.54 +      <command>pwm-clip</command>
    1.55 +    </cmdsynopsis>
    1.56 +  </refsynopsisdiv>
    1.57 +  <refsect1>
    1.58 +    <title>Description</title>
    1.59 +    <para>The <command>pwm-clip</command> utility reads from the standard input
    1.60 +    stream until it encounters a newline character or the stream is at
    1.61 +    end-of-file, then removes any newline character at the end and places the
    1.62 +    data in the system clipboard. On X11 systems it sets the CLIPBOARD
    1.63 +    selection.</para>
    1.64 +    <para>The following terminals are currently supported:
    1.65 +    <simplelist type="horiz" columns="3">
    1.66 +      <member>xterm</member>
    1.67 +      <member>tmux</member>
    1.68 +      <member>screen</member>
    1.69 +    </simplelist>
    1.70 +    </para>
    1.71 +    <para>If <command>pwm-clip</command> is invoked in an unsupported terminal
    1.72 +    it will print an error message and exit.</para>
    1.73 +  </refsect1>
    1.74 +  <refsect1>
    1.75 +    <title>Environment Variables</title>
    1.76 +    <variablelist>
    1.77 +      <varlistentry>
    1.78 +        <term>
    1.79 +          <literal>TERM</literal>
    1.80 +        </term>
    1.81 +        <listitem>
    1.82 +          <para>The name of the terminal used by <command>pwm-clip</command> to
    1.83 +          determine whether setting the system clipboard is supported</para>
    1.84 +        </listitem>
    1.85 +      </varlistentry>
    1.86 +    </variablelist>
    1.87 +  </refsect1>
    1.88 +  <refsect1>
    1.89 +    <title>Exit Status</title>
    1.90 +    <para>The following exit values are returned:</para>
    1.91 +    <variablelist>
    1.92 +      <varlistentry>
    1.93 +        <term>0</term>
    1.94 +        <listitem>
    1.95 +          <para>Command successfully executed.</para>
    1.96 +        </listitem>
    1.97 +      </varlistentry>
    1.98 +      <varlistentry>
    1.99 +        <term>1</term>
   1.100 +        <listitem>
   1.101 +          <para>An unspecified error has occured.</para>
   1.102 +        </listitem>
   1.103 +      </varlistentry>
   1.104 +      <varlistentry>
   1.105 +        <term>2</term>
   1.106 +        <listitem>
   1.107 +          <para>Invalid command line options were specified.</para>
   1.108 +        </listitem>
   1.109 +      </varlistentry>
   1.110 +    </variablelist>
   1.111 +  </refsect1>
   1.112 +  <refsect1>
   1.113 +    <title>See Also</title>
   1.114 +    <para><citerefentry><refentrytitle>pwm</refentrytitle>
   1.115 +      <manvolnum>1</manvolnum></citerefentry>,
   1.116 +      <citerefentry><refentrytitle>xterm</refentrytitle>
   1.117 +      <manvolnum>1</manvolnum></citerefentry>,
   1.118 +      <citerefentry><refentrytitle>tmux</refentrytitle>
   1.119 +      <manvolnum>1</manvolnum></citerefentry>,
   1.120 +      <citerefentry><refentrytitle>screen</refentrytitle>
   1.121 +      <manvolnum>1</manvolnum></citerefentry></para>
   1.122 +  </refsect1>
   1.123 +</refentry>