pee.docbook

   1 <?xml version="1.0" encoding="utf-8"?>
   2
   3 <!--
   4
   5 Copyright 2006 Joey Hess <id@joeyh.name>
   6
   7 This program is free software; you can redistribute it and/or modify it
   8 under the terms of the GNU General Public License as published by the
   9 Free Software Foundation; either version 2 of the License, or (at your
  10 option) any later version.
  11
  12 This program is distributed in the hope that it will be useful, but
  13 WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
  15 Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License along
  18 with this program; if not, write to the Free Software Foundation, Inc.,
  19 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  20
  21 -->
  22
  23 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
  24 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
  25 []>
  26
  27 <refentry>
  28         <refentryinfo>
  29                 <address>
  30                         <email>id@joeyh.name</email>
  31                 </address>
  32                 <author>
  33                         <firstname>Joey</firstname>
  34                         <surname>Hess</surname>
  35                 </author>
  36                 <date>2016-12-20</date>
  37         </refentryinfo>
  38
  39         <refmeta>
  40                 <refentrytitle>pee</refentrytitle>
  41                 <manvolnum>1</manvolnum>
  42                 <refmiscinfo class="manual">moreutils</refmiscinfo>
  43                 <refmiscinfo class="source">moreutils</refmiscinfo>
  44         </refmeta>
  45
  46         <refnamediv>
  47                 <refname>pee</refname>
  48                 <refpurpose>tee standard input to pipes</refpurpose>
  49         </refnamediv>
  50
  51         <refsynopsisdiv>
  52                 <cmdsynopsis>
  53                         <command>pee</command>
  54                         <arg>--[no-]ignore-sigpipe</arg>
  55                         <arg>--[no-]ignore-write-errors</arg>
  56                         <group choice="opt">
  57                                 <arg rep="repeat"><replaceable>"command"</replaceable></arg>
  58                         </group>
  59                 </cmdsynopsis>
  60         </refsynopsisdiv>
  61
  62         <refsect1>
  63                 <title>DESCRIPTION</title>
  64
  65                 <para><command>pee</command> is like <command>tee</command>
  66                 but for pipes. Each command is run and fed a copy of the
  67                 standard input. The output of all commands is sent to
  68                 stdout.</para>
  69
  70                 <para>Note that while this is similar to
  71                 <command>tee</command>, a copy of the input is not sent
  72                 to stdout, like tee does. If that is desired, use
  73                 <command>pee cat ...</command></para>
  74         </refsect1>
  75
  76         <refsect1>
  77                 <title>OPTIONS</title>
  78
  79                 <variablelist>
  80                     <varlistentry>
  81                         <term><option>--ignore-sigpipe</option></term>
  82                         <term><option>--no-ignore-sigpipe</option></term>
  83                         <listitem>
  84                             <para>Do (not) ignore SIGPIPE.  Any command started
  85                             by <command>pee</command> might cause a SIGPIPE
  86                             when it exists.  If you ignore SIGPIPE, you
  87                             probably also want to ignore write errors (see
  88                             below).  Ignoring SIGPIPE is the default
  89                             behaviour.</para>
  90                         </listitem>
  91                     </varlistentry>
  92
  93                     <varlistentry>
  94                         <term><option>--ignore-write-errors</option></term>
  95                         <term><option>--no-ignore-write-errors</option></term>
  96                         <listitem>
  97                             <para>Do (not) ignore write errors.  When a command
  98                             started by <command>pee</command> is no more
  99                             accepting data via the pipe between itself and
 100                             <command>pee</command>, a write error occurs in
 101                             <command>pee</command>.  If this error is not
 102                             ignored, <command>pee</command> is going to
 103                             terminate all child processes and exists.  Ignoring
 104                             write errors is the default behaviour.</para>
 105                         </listitem>
 106                     </varlistentry>
 107
 108                 </variablelist>
 109         </refsect1>
 110
 111         <refsect1>
 112                 <title>SEE ALSO</title>
 113
 114                 <para>
 115                         <citerefentry>
 116                                 <refentrytitle>tee</refentrytitle><manvolnum>1</manvolnum>
 117                         </citerefentry>,
 118                         <citerefentry>
 119                                 <refentrytitle>pipe</refentrytitle><manvolnum>7</manvolnum>
 120                         </citerefentry>
 121                 </para>
 122
 123         </refsect1>
 124
 125         <refsect1>
 126                 <title>AUTHOR</title>
 127                 <para>
 128                         Miek Gieben
 129                 </para>
 130         </refsect1>
 131 </refentry>