isutf8.docbook

   1 <?xml version="1.0" encoding="utf-8"?>
   2
   3 <!--
   4
   5 Copyright 2006 Lars Wirzenius (liw@iki.fi)
   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>liw@iki.fi</email>
  31                 </address>
  32                 <author>
  33                         <firstname>Lars</firstname>
  34                         <surname>Wirzenius</surname>
  35                 </author>
  36                 <date>2006-02-19</date>
  37         </refentryinfo>
  38
  39         <refmeta>
  40                 <refentrytitle>isutf8</refentrytitle>
  41                 <manvolnum>1</manvolnum>
  42         </refmeta>
  43
  44         <refnamediv>
  45                 <refname>isutf8</refname>
  46                 <refpurpose>check whether files are valid UTF-8</refpurpose>
  47         </refnamediv>
  48
  49         <refsynopsisdiv>
  50                 <cmdsynopsis>
  51                         <command>isutf8</command>
  52                         <arg><option>-hq</option></arg>
  53                         <arg><option>--help</option></arg>
  54                         <arg><option>--quiet</option></arg>
  55                         <group choice="opt">
  56                                         <arg rep="repeat"><replaceable>file</replaceable></arg>
  57                         </group>
  58                 </cmdsynopsis>
  59         </refsynopsisdiv>
  60
  61         <refsect1>
  62                 <title>DESCRIPTION</title>
  63
  64                 <para><command>isutf8</command> checks whether files are
  65                 syntactically valid UTF-8. Input is either files named on the
  66                 command line, or the standard input. Notices about files with
  67                 invalid UTF-8 are printed to standard output.</para>
  68
  69         </refsect1>
  70
  71         <refsect1>
  72                 <title>OPTIONS</title>
  73
  74                 <variablelist>
  75
  76                 <varlistentry>
  77                         <term><option>-h</option></term>
  78                         <term><option>--help</option></term>
  79                         <listitem>
  80                                         <para>Print out a help summary.</para>
  81                         </listitem>
  82                 </varlistentry>
  83
  84                 <varlistentry>
  85                         <term><option>-q</option></term>
  86                         <term><option>--quiet</option></term>
  87                         <listitem>
  88                                 <para>Don't print messages telling which files are
  89                                 invalid UTF-8, merely indicate it with the exit
  90                                 status.</para>
  91                         </listitem>
  92                 </varlistentry>
  93
  94                 </variablelist>
  95
  96         </refsect1>
  97
  98         <refsect1>
  99                 <title>EXIT STATUS</title>
 100
 101                 <para>If the file is valid UTF-8, the exit status is zero.
 102                         If the file is not valid UTF-8, or there is some
 103                         error, the exit status is non-zero.</para>
 104
 105         </refsect1>
 106
 107         <refsect1>
 108                 <title>SEE ALSO</title>
 109
 110                 <para>
 111                         <citerefentry>
 112                                 <refentrytitle>utf8</refentrytitle><manvolnum>7</manvolnum>
 113                         </citerefentry>
 114                 </para>
 115
 116         </refsect1>
 117 </refentry>