summaryrefslogtreecommitdiff
path: root/errno.docbook
blob: e045f7e90d9f774bbc76c7cda0d81136d1200533 (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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
<?xml version="1.0" encoding="utf-8"?>

<!--

Copyright 2012 Lars Wirzenius (liw@iki.fi)

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"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
[]>

<refentry>
	<refentryinfo>
		<address>
			<email>liw@liw.fi</email>
		</address>
		<author>
			<firstname>Lars</firstname>
			<surname>Wirzenius</surname>
		</author>
		<date>2012-06-05</date>
	</refentryinfo>

	<refmeta>
		<refentrytitle>errno</refentrytitle>
		<manvolnum>1</manvolnum>
		<refmiscinfo class="manual">moreutils</refmiscinfo>
		<refmiscinfo class="source">moreutils</refmiscinfo>
	</refmeta>

	<refnamediv>
		<refname>errno</refname> 
		<refpurpose>look up errno names and descriptions</refpurpose>
	</refnamediv>

	<refsynopsisdiv>
		<cmdsynopsis>
			<command>errno</command>
            <arg choice="req"><replaceable>name-or-code</replaceable></arg>
		</cmdsynopsis>
		<cmdsynopsis>
			<command>errno</command>
            <arg>-ls</arg>
            <arg>--list</arg>
		</cmdsynopsis>
		<cmdsynopsis>
			<command>errno</command>
            <arg>-s</arg>
            <arg>--search</arg>
            <arg choice="req"><replaceable>word</replaceable></arg>
		</cmdsynopsis>
		<cmdsynopsis>
			<command>errno</command>
            <arg>-S</arg>
            <arg>--search-all-locales</arg>
            <arg choice="req"><replaceable>word</replaceable></arg>
		</cmdsynopsis>
	</refsynopsisdiv>
	
	<refsect1>
		<title>DESCRIPTION</title>
		
		<para><command>errno</command> looks up errno macro names,
		errno codes, and the corresponding descriptions. For example,
		if given <literal>ENOENT</literal> on a Linux system, it
		prints out the code 2 and the description "No such file or directory".
		If given the code 2, it printes <literal>ENOENT</literal>
		and the same description.</para>
		
	</refsect1>
	
	<refsect1>
        <title>OPTIONS</title>
        
        <variablelist>
            <varlistentry>
                <term><option>-l</option></term>
                <term><option>--list</option></term>
                <listitem>
                    <para>List all errno values.</para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term><option>-s</option></term>
                <term><option>--search</option></term>
                <listitem>
                    <para>Search for errors whose description contains
                    all the given words (case-insensitive).</para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term><option>-S</option></term>
                <term><option>--search-all-locales</option></term>
                <listitem>
                    <para>Like <option>--search</option>, but searches all
                    installed locales.</para>
                </listitem>
            </varlistentry>
        </variablelist>

	</refsect1>
	
	<refsect1>
		<title>AUTHOR</title>

		<para>
			Lars Wirzenius
		</para>
	</refsect1>
	
	<refsect1>
		<title>SEE ALSO</title>
		
		<para>
			<citerefentry>
				<refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum>
			</citerefentry>
		</para>
		
	</refsect1>
</refentry>