mispipe.docbook

   1 <?xml version="1.0" encoding="utf-8"?>
   2
   3 <!--
   4
   5 Copyright 2006 Joey Hess <joey@kitenet.net>
   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 "file:///usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd"
  25 []>
  26
  27 <refentry>
  28         <refentryinfo>
  29                 <address>
  30                         <email>neroden@fastmail.fm</email>
  31                 </address>
  32                 <author>
  33                         <firstname>Nathanael</firstname>
  34                         <surname>Nerode</surname>
  35                 </author>
  36                 <date>2006-09-07</date>
  37         </refentryinfo>
  38
  39         <refmeta>
  40                 <refentrytitle>mispipe</refentrytitle>
  41                 <manvolnum>1</manvolnum>
  42         </refmeta>
  43
  44         <refnamediv>
  45                 <refname>mispipe</refname>
  46                 <refpurpose>pipe two commands, returning the exit status of
  47                 the first</refpurpose>
  48         </refnamediv>
  49
  50         <refsynopsisdiv>
  51                 <cmdsynopsis>
  52                         <command>mispipe</command>
  53                         <arg><replaceable>"command1"</replaceable></arg>
  54                         <arg><replaceable>"command2"</replaceable></arg>
  55                 </cmdsynopsis>
  56         </refsynopsisdiv>
  57
  58         <refsect1>
  59                 <title>DESCRIPTION</title>
  60
  61                 <para><command>mispipe</command> pipes two commands
  62                 together like the shell does, but unlike piping in the
  63                 shell, the exit status of the first command is returned.
  64                 </para>
  65
  66                 <para>
  67                 Note that some shells, notably <command>bash</command>,
  68                 do offer a pipefail option, however, that option does not
  69                 behave the same since it makes a failure of any command in
  70                 the pipeline be returned, not just the exit status of the
  71                 first.
  72                 </para>
  73
  74         </refsect1>
  75
  76         <refsect1>
  77                 <title>EXIT STATUS</title>
  78
  79                 <para>The exit status of the first command. If the process
  80                 terminated abnormally (due to a signal), 128 will be added
  81                 to its exit status.</para>
  82
  83         </refsect1>
  84 </refentry>