guido+pwm@26: <?xml version="1.0"?>
guido+pwm@26: <!--
guido+pwm@26: 
guido+pwm@26: Copyright (C) 2017 Guido Berhoerster <guido+pwm@berhoerster.name>
guido+pwm@26: 
guido+pwm@26: Permission is hereby granted, free of charge, to any person obtaining
guido+pwm@26: a copy of this software and associated documentation files (the
guido+pwm@26: "Software"), to deal in the Software without restriction, including
guido+pwm@26: without limitation the rights to use, copy, modify, merge, publish,
guido+pwm@26: distribute, sublicense, and/or sell copies of the Software, and to
guido+pwm@26: permit persons to whom the Software is furnished to do so, subject to
guido+pwm@26: the following conditions:
guido+pwm@26: 
guido+pwm@26: The above copyright notice and this permission notice shall be included
guido+pwm@26: in all copies or substantial portions of the Software.
guido+pwm@26: 
guido+pwm@26: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
guido+pwm@26: EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
guido+pwm@26: MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
guido+pwm@26: IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
guido+pwm@26: CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
guido+pwm@26: TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
guido+pwm@26: SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
guido+pwm@26: 
guido+pwm@26: -->
guido+pwm@26: <refentry xmlns="http://docbook.org/ns/docbook" xml:lang="en">
guido+pwm@26:   <info>
guido+pwm@26:     <author>
guido+pwm@26:       <personname>
guido+pwm@26:         <firstname>Guido</firstname>
guido+pwm@26:         <surname>Berhoerster</surname>
guido+pwm@26:       </personname>
guido+pwm@26:       <email>guido+pwm@berhoerster.name</email>
guido+pwm@26:       <personblurb/>
guido+pwm@26:     </author>
guido+pwm@26:     <date>21 September, 2017</date>
guido+pwm@26:   </info>
guido+pwm@26:   <refmeta>
guido+pwm@26:     <refentrytitle>pwm-clip</refentrytitle>
guido+pwm@26:     <manvolnum>1</manvolnum>
guido+pwm@26:     <refmiscinfo class="source"/>
guido+pwm@26:     <refmiscinfo class="version"/>
guido+pwm@26:     <refmiscinfo class="manual">User Commands</refmiscinfo>
guido+pwm@26:   </refmeta>
guido+pwm@26:   <refnamediv>
guido+pwm@26:     <refname>pwm-clip</refname>
guido+pwm@26:     <refpurpose>set the system clipboard</refpurpose>
guido+pwm@26:   </refnamediv>
guido+pwm@26:   <refsynopsisdiv>
guido+pwm@26:     <cmdsynopsis>
guido+pwm@26:       <command>pwm-clip</command>
guido+pwm@26:     </cmdsynopsis>
guido+pwm@26:   </refsynopsisdiv>
guido+pwm@26:   <refsect1>
guido+pwm@26:     <title>Description</title>
guido+pwm@26:     <para>The <command>pwm-clip</command> utility reads from the standard input
guido+pwm@26:     stream until it encounters a newline character or the stream is at
guido+pwm@26:     end-of-file, then removes any newline character at the end and places the
guido+pwm@26:     data in the system clipboard. On X11 systems it sets the CLIPBOARD
guido+pwm@26:     selection.</para>
guido+pwm@26:     <para>The following terminals are currently supported:
guido+pwm@26:     <simplelist type="horiz" columns="3">
guido+pwm@26:       <member>xterm</member>
guido+pwm@26:       <member>tmux</member>
guido+pwm@26:       <member>screen</member>
guido+pwm@26:     </simplelist>
guido+pwm@26:     </para>
guido+pwm@26:     <para>If <command>pwm-clip</command> is invoked in an unsupported terminal
guido+pwm@26:     it will print an error message and exit.</para>
guido+pwm@26:   </refsect1>
guido+pwm@26:   <refsect1>
guido+pwm@26:     <title>Environment Variables</title>
guido+pwm@26:     <variablelist>
guido+pwm@26:       <varlistentry>
guido+pwm@26:         <term>
guido+pwm@26:           <literal>TERM</literal>
guido+pwm@26:         </term>
guido+pwm@26:         <listitem>
guido+pwm@26:           <para>The name of the terminal used by <command>pwm-clip</command> to
guido+pwm@26:           determine whether setting the system clipboard is supported</para>
guido+pwm@26:         </listitem>
guido+pwm@26:       </varlistentry>
guido+pwm@26:     </variablelist>
guido+pwm@26:   </refsect1>
guido+pwm@26:   <refsect1>
guido+pwm@26:     <title>Exit Status</title>
guido+pwm@26:     <para>The following exit values are returned:</para>
guido+pwm@26:     <variablelist>
guido+pwm@26:       <varlistentry>
guido+pwm@26:         <term>0</term>
guido+pwm@26:         <listitem>
guido+pwm@26:           <para>Command successfully executed.</para>
guido+pwm@26:         </listitem>
guido+pwm@26:       </varlistentry>
guido+pwm@26:       <varlistentry>
guido+pwm@26:         <term>1</term>
guido+pwm@26:         <listitem>
guido+pwm@26:           <para>An unspecified error has occured.</para>
guido+pwm@26:         </listitem>
guido+pwm@26:       </varlistentry>
guido+pwm@26:       <varlistentry>
guido+pwm@26:         <term>2</term>
guido+pwm@26:         <listitem>
guido+pwm@26:           <para>Invalid command line options were specified.</para>
guido+pwm@26:         </listitem>
guido+pwm@26:       </varlistentry>
guido+pwm@26:     </variablelist>
guido+pwm@26:   </refsect1>
guido+pwm@26:   <refsect1>
guido+pwm@26:     <title>See Also</title>
guido+pwm@26:     <para><citerefentry><refentrytitle>pwm</refentrytitle>
guido+pwm@26:       <manvolnum>1</manvolnum></citerefentry>,
guido+pwm@26:       <citerefentry><refentrytitle>xterm</refentrytitle>
guido+pwm@26:       <manvolnum>1</manvolnum></citerefentry>,
guido+pwm@26:       <citerefentry><refentrytitle>tmux</refentrytitle>
guido+pwm@26:       <manvolnum>1</manvolnum></citerefentry>,
guido+pwm@26:       <citerefentry><refentrytitle>screen</refentrytitle>
guido+pwm@26:       <manvolnum>1</manvolnum></citerefentry></para>
guido+pwm@26:   </refsect1>
guido+pwm@26: </refentry>