projects/pwm

annotate 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
rev   line source
guido+pwm@26 1 <?xml version="1.0"?>
guido+pwm@26 2 <!--
guido+pwm@26 3
guido+pwm@26 4 Copyright (C) 2017 Guido Berhoerster <guido+pwm@berhoerster.name>
guido+pwm@26 5
guido+pwm@26 6 Permission is hereby granted, free of charge, to any person obtaining
guido+pwm@26 7 a copy of this software and associated documentation files (the
guido+pwm@26 8 "Software"), to deal in the Software without restriction, including
guido+pwm@26 9 without limitation the rights to use, copy, modify, merge, publish,
guido+pwm@26 10 distribute, sublicense, and/or sell copies of the Software, and to
guido+pwm@26 11 permit persons to whom the Software is furnished to do so, subject to
guido+pwm@26 12 the following conditions:
guido+pwm@26 13
guido+pwm@26 14 The above copyright notice and this permission notice shall be included
guido+pwm@26 15 in all copies or substantial portions of the Software.
guido+pwm@26 16
guido+pwm@26 17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
guido+pwm@26 18 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
guido+pwm@26 19 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
guido+pwm@26 20 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
guido+pwm@26 21 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
guido+pwm@26 22 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
guido+pwm@26 23 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
guido+pwm@26 24
guido+pwm@26 25 -->
guido+pwm@26 26 <refentry xmlns="http://docbook.org/ns/docbook" xml:lang="en">
guido+pwm@26 27 <info>
guido+pwm@26 28 <author>
guido+pwm@26 29 <personname>
guido+pwm@26 30 <firstname>Guido</firstname>
guido+pwm@26 31 <surname>Berhoerster</surname>
guido+pwm@26 32 </personname>
guido+pwm@26 33 <email>guido+pwm@berhoerster.name</email>
guido+pwm@26 34 <personblurb/>
guido+pwm@26 35 </author>
guido+pwm@26 36 <date>21 September, 2017</date>
guido+pwm@26 37 </info>
guido+pwm@26 38 <refmeta>
guido+pwm@26 39 <refentrytitle>pwm-clip</refentrytitle>
guido+pwm@26 40 <manvolnum>1</manvolnum>
guido+pwm@26 41 <refmiscinfo class="source"/>
guido+pwm@26 42 <refmiscinfo class="version"/>
guido+pwm@26 43 <refmiscinfo class="manual">User Commands</refmiscinfo>
guido+pwm@26 44 </refmeta>
guido+pwm@26 45 <refnamediv>
guido+pwm@26 46 <refname>pwm-clip</refname>
guido+pwm@26 47 <refpurpose>set the system clipboard</refpurpose>
guido+pwm@26 48 </refnamediv>
guido+pwm@26 49 <refsynopsisdiv>
guido+pwm@26 50 <cmdsynopsis>
guido+pwm@26 51 <command>pwm-clip</command>
guido+pwm@26 52 </cmdsynopsis>
guido+pwm@26 53 </refsynopsisdiv>
guido+pwm@26 54 <refsect1>
guido+pwm@26 55 <title>Description</title>
guido+pwm@26 56 <para>The <command>pwm-clip</command> utility reads from the standard input
guido+pwm@26 57 stream until it encounters a newline character or the stream is at
guido+pwm@26 58 end-of-file, then removes any newline character at the end and places the
guido+pwm@26 59 data in the system clipboard. On X11 systems it sets the CLIPBOARD
guido+pwm@26 60 selection.</para>
guido+pwm@26 61 <para>The following terminals are currently supported:
guido+pwm@26 62 <simplelist type="horiz" columns="3">
guido+pwm@26 63 <member>xterm</member>
guido+pwm@26 64 <member>tmux</member>
guido+pwm@26 65 <member>screen</member>
guido+pwm@26 66 </simplelist>
guido+pwm@26 67 </para>
guido+pwm@26 68 <para>If <command>pwm-clip</command> is invoked in an unsupported terminal
guido+pwm@26 69 it will print an error message and exit.</para>
guido+pwm@26 70 </refsect1>
guido+pwm@26 71 <refsect1>
guido+pwm@26 72 <title>Environment Variables</title>
guido+pwm@26 73 <variablelist>
guido+pwm@26 74 <varlistentry>
guido+pwm@26 75 <term>
guido+pwm@26 76 <literal>TERM</literal>
guido+pwm@26 77 </term>
guido+pwm@26 78 <listitem>
guido+pwm@26 79 <para>The name of the terminal used by <command>pwm-clip</command> to
guido+pwm@26 80 determine whether setting the system clipboard is supported</para>
guido+pwm@26 81 </listitem>
guido+pwm@26 82 </varlistentry>
guido+pwm@26 83 </variablelist>
guido+pwm@26 84 </refsect1>
guido+pwm@26 85 <refsect1>
guido+pwm@26 86 <title>Exit Status</title>
guido+pwm@26 87 <para>The following exit values are returned:</para>
guido+pwm@26 88 <variablelist>
guido+pwm@26 89 <varlistentry>
guido+pwm@26 90 <term>0</term>
guido+pwm@26 91 <listitem>
guido+pwm@26 92 <para>Command successfully executed.</para>
guido+pwm@26 93 </listitem>
guido+pwm@26 94 </varlistentry>
guido+pwm@26 95 <varlistentry>
guido+pwm@26 96 <term>1</term>
guido+pwm@26 97 <listitem>
guido+pwm@26 98 <para>An unspecified error has occured.</para>
guido+pwm@26 99 </listitem>
guido+pwm@26 100 </varlistentry>
guido+pwm@26 101 <varlistentry>
guido+pwm@26 102 <term>2</term>
guido+pwm@26 103 <listitem>
guido+pwm@26 104 <para>Invalid command line options were specified.</para>
guido+pwm@26 105 </listitem>
guido+pwm@26 106 </varlistentry>
guido+pwm@26 107 </variablelist>
guido+pwm@26 108 </refsect1>
guido+pwm@26 109 <refsect1>
guido+pwm@26 110 <title>See Also</title>
guido+pwm@26 111 <para><citerefentry><refentrytitle>pwm</refentrytitle>
guido+pwm@26 112 <manvolnum>1</manvolnum></citerefentry>,
guido+pwm@26 113 <citerefentry><refentrytitle>xterm</refentrytitle>
guido+pwm@26 114 <manvolnum>1</manvolnum></citerefentry>,
guido+pwm@26 115 <citerefentry><refentrytitle>tmux</refentrytitle>
guido+pwm@26 116 <manvolnum>1</manvolnum></citerefentry>,
guido+pwm@26 117 <citerefentry><refentrytitle>screen</refentrytitle>
guido+pwm@26 118 <manvolnum>1</manvolnum></citerefentry></para>
guido+pwm@26 119 </refsect1>
guido+pwm@26 120 </refentry>