mispipe.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>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                 <refmiscinfo class="manual">moreutils</refmiscinfo>
  43                 <refmiscinfo class="source">moreutils</refmiscinfo>
  44         </refmeta>
  45
  46         <refnamediv>
  47                 <refname>mispipe</refname>
  48                 <refpurpose>pipe two commands, returning the exit status of
  49                 the first</refpurpose>
  50         </refnamediv>
  51
  52         <refsynopsisdiv>
  53                 <cmdsynopsis>
  54                         <command>mispipe</command>
  55                         <arg><replaceable>"command1"</replaceable></arg>
  56                         <arg><replaceable>"command2"</replaceable></arg>
  57                 </cmdsynopsis>
  58         </refsynopsisdiv>
  59
  60         <refsect1>
  61                 <title>DESCRIPTION</title>
  62
  63                 <para><command>mispipe</command> pipes two commands
  64                 together like the shell does, but unlike piping in the
  65                 shell, which returns the exit status of the last command;
  66                 when using mispipe, the exit status of the first command
  67                 is returned.
  68                 </para>
  69
  70                 <para>
  71                 Note that some shells, notably <command>bash</command>,
  72                 do offer a pipefail option, however, that option does not
  73                 behave the same since it makes a failure of any command in
  74                 the pipeline be returned, not just the exit status of the
  75                 first.
  76                 </para>
  77
  78         </refsect1>
  79
  80         <refsect1>
  81                 <title>EXIT STATUS</title>
  82
  83                 <para>The exit status of the first command. If the process
  84                 terminated abnormally (due to a signal), 128 will be added
  85                 to its exit status.</para>
  86
  87         </refsect1>
  88
  89         <refsect1>
  90                 <title>AUTHOR</title>
  91                 <para>
  92                         Nathanael Nerode
  93                 </para>
  94         </refsect1>
  95 </refentry>