summaryrefslogtreecommitdiff
path: root/ifne.docbook
blob: 41fa9abe7a23b63f5afd110dcd0b3f78b0e4c531 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
<?xml version="1.0" encoding="utf-8"?>

<!--

Copyright 2008 Javier Merino <cibervicho@gmail.com>

This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

-->

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
"file:///usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd"
[]>

<refentry>
	<refentryinfo>
		<address>
			<email>cibervicho@gmail.com</email>
		</address>
		<author>
			<firstname>Javier</firstname>
			<surname>Merino</surname>
		</author>
		<date>2008-05-01</date>
	</refentryinfo>

	<refmeta>
		<refentrytitle>ifne</refentrytitle>
		<manvolnum>1</manvolnum>
	</refmeta>

	<refnamediv>
		<refname>ifne</refname> 
		<refpurpose>Run command if the standard input is not empty</refpurpose>
	</refnamediv>

	<refsynopsisdiv>
		<cmdsynopsis>
			<command>ifne [-n] command</command>
		</cmdsynopsis>
	</refsynopsisdiv>
	
	<refsect1>
		<title>DESCRIPTION</title>
		
		<para><command>ifne</command> runs the following command if and only if
			the standard input is not empty.</para>
	</refsect1>
	
	<refsect1>
		<title>OPTIONS</title>

		<variablelist>
			<varlistentry>
				<term><option>-n</option></term>
				<listitem>
					<para>Reverse operation. Run the command if the standard input is empty.</para>
					<para>Note that if the standard input is not empty, it is passed through ifne
					in this case.</para>
				</listitem>
			</varlistentry>
		</variablelist>
	</refsect1>

	<refsect1>
		<title>EXAMPLE</title>
		<cmdsynopsis>
			<command>find . -name core | ifne mail -s "Core files found" root</command>
		</cmdsynopsis>
	</refsect1>

	<refsect1>
		<title>AUTHOR</title>

		<para>Copyright 2008 by Javier Merino &lt;cibervicho@gmail.com&gt;</para>
		<para>Licensed under the GNU GPL</para>
	</refsect1>

</refentry>