<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [

<!--ArborText, Inc., 1988-1999, v.4002-->

<!ENTITY envr-tt "ENVIRONMENT VARIABLES">

<!ENTITY cmd "gpg-error">

<!ENTITY % commonents SYSTEM "smancommon.ent">

%commonents;

<!ENTITY % booktitles SYSTEM "booktitles.ent">

%booktitles;

<!ENTITY suncopy "Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.">

]>

<?Pub UDT _bookmark _target>

<?Pub Inc>

<refentry id="gpg-error-1">

<refmeta><refentrytitle>&cmd;</refentrytitle><manvolnum>1</manvolnum>

<refmiscinfo class="date">31 Jul 2008</refmiscinfo>

<refmiscinfo class="sectdesc">&man1;</refmiscinfo>

<refmiscinfo class="software">&release;</refmiscinfo>

<refmiscinfo class="arch">generic</refmiscinfo>

<refmiscinfo class="copyright">&suncopy;</refmiscinfo>

</refmeta>

<refnamediv id="gpg-error-1-name">

<indexterm><primary>&cmd;</primary></indexterm>

<refname>&cmd;</refname><refpurpose>

Get the description for specified error numbers.

</refpurpose></refnamediv>

<refsynopsisdiv id="gpg-error-1-synp"><title>&synp-tt;</title>

<cmdsynopsis><command>&cmd;</command>

<arg choice="plain"><option role="nodash"><replaceable>errorno</replaceable></option></arg>

<arg choice="opt"><option role="nodash"><replaceable>...</replaceable></option></arg>

</cmdsynopsis></refsynopsisdiv>

<refsect1 id="gpg-error-1-desc"><title>&desc-tt;</title>

<para>&cmd; is a tool that returns the description of specified error numbers.

</para>

</refsect1>

<refsect1 id="gpg-error-1-oper"><title>&oper-tt;</title>

<para>The following operands are supported:</para>

<variablelist termlength="xtranarrow">

<varlistentry><term><option role="nodash"><replaceable>errorno</replaceable></option></term>

<listitem><para>Error numbers for which you want to get the description.</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="gpg-error-1-exit"><title>&exit-tt;</title>

<para>The following exit values are returned:</para>

<variablelist termlength="xtranarrow">

<varlistentry><term><returnvalue>0</returnvalue></term><listitem><para>Application

exited successfully</para>

</listitem></varlistentry>

<varlistentry><term><returnvalue>1</returnvalue></term><listitem><para>Application

exited with failure</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="gpg-error-1-file"><title>&file-tt;</title>

<para>The following files are used by this application:</para>

<variablelist termlength="medium">

<varlistentry><term><filename>/usr/bin/&cmd;</filename> </term><listitem>

<para>Executable for &cmd;</para>

</listitem></varlistentry>

</varlistentry>

</refsect1>

<refsect1 id="gpg-error-1-attr"><title>&attr-tt;</title>

<para>See <olink targetdocent="REFMAN2" localinfo="attributes-5"><citerefentry>

<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>

for descriptions of the following attributes:</para>

<informaltable frame="all">

<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">

<colspec colname="COLSPEC1" colwidth="1*">

<thead>

<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"

valign="middle">ATTRIBUTE VALUE</entry></row>

</thead>

<tbody>

<row><entry><para>Availability</para></entry><entry><para>library/security/libgpg-error</para></entry>

</row>

<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry

colname="COLSPEC1"><para>Volatile</para></entry></row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 id="gpg-error-1-also"><title>&also-tt;</title>

<para>

<citerefentry><refentrytitle>gpg-error-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>libgpg-error</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>

</para>

</refsect1>

<para>

Written by Jeff Cai, Sun Microsystems Inc., 2008.

</para>

</refsect1>

</refentry>