Mercurial > projects > pwm

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add pwm-clip utility for setting the X11 CLIPBOARD selection
author Guido Berhoerster <guido+pwm@berhoerster.name>
date Thu, 21 Sep 2017 09:45:59 +0200
parents
children
comparison
equal deleted inserted replaced
25:616385fa1fd9 26:5bdea77d0c1d
1 <?xml version="1.0"?>
2 <!--
3
4 Copyright (C) 2017 Guido Berhoerster <guido+pwm@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+pwm@berhoerster.name</email>
34 <personblurb/>
35 </author>
36 <date>21 September, 2017</date>
37 </info>
38 <refmeta>
39 <refentrytitle>pwm-clip</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>pwm-clip</refname>
47 <refpurpose>set the system clipboard</refpurpose>
48 </refnamediv>
49 <refsynopsisdiv>
50 <cmdsynopsis>
51 <command>pwm-clip</command>
52 </cmdsynopsis>
53 </refsynopsisdiv>
54 <refsect1>
55 <title>Description</title>
56 <para>The <command>pwm-clip</command> utility reads from the standard input
57 stream until it encounters a newline character or the stream is at
58 end-of-file, then removes any newline character at the end and places the
59 data in the system clipboard. On X11 systems it sets the CLIPBOARD
60 selection.</para>
61 <para>The following terminals are currently supported:
62 <simplelist type="horiz" columns="3">
63 <member>xterm</member>
64 <member>tmux</member>
65 <member>screen</member>
66 </simplelist>
67 </para>
68 <para>If <command>pwm-clip</command> is invoked in an unsupported terminal
69 it will print an error message and exit.</para>
70 </refsect1>
71 <refsect1>
72 <title>Environment Variables</title>
73 <variablelist>
74 <varlistentry>
75 <term>
76 <literal>TERM</literal>
77 </term>
78 <listitem>
79 <para>The name of the terminal used by <command>pwm-clip</command> to
80 determine whether setting the system clipboard is supported</para>
81 </listitem>
82 </varlistentry>
83 </variablelist>
84 </refsect1>
85 <refsect1>
86 <title>Exit Status</title>
87 <para>The following exit values are returned:</para>
88 <variablelist>
89 <varlistentry>
90 <term>0</term>
91 <listitem>
92 <para>Command successfully executed.</para>
93 </listitem>
94 </varlistentry>
95 <varlistentry>
96 <term>1</term>
97 <listitem>
98 <para>An unspecified error has occured.</para>
99 </listitem>
100 </varlistentry>
101 <varlistentry>
102 <term>2</term>
103 <listitem>
104 <para>Invalid command line options were specified.</para>
105 </listitem>
106 </varlistentry>
107 </variablelist>
108 </refsect1>
109 <refsect1>
110 <title>See Also</title>
111 <para><citerefentry><refentrytitle>pwm</refentrytitle>
112 <manvolnum>1</manvolnum></citerefentry>,
113 <citerefentry><refentrytitle>xterm</refentrytitle>
114 <manvolnum>1</manvolnum></citerefentry>,
115 <citerefentry><refentrytitle>tmux</refentrytitle>
116 <manvolnum>1</manvolnum></citerefentry>,
117 <citerefentry><refentrytitle>screen</refentrytitle>
118 <manvolnum>1</manvolnum></citerefentry></para>
119 </refsect1>
120 </refentry>