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 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
  25 []>
  26
  27 <refentry>
  28         <refentryinfo>
  29                 <authorgroup>
  30                         <author>
  31                                 <firstname>Lars</firstname>
  32                                 <surname>Wirzenius</surname>
  33                                 <email>liw@iki.fi</email>
  34                         </author>
  35                         <author>
  36                                 <firstname>Julien</firstname>
  37                                 <surname>Palard</surname>
  38                                 <email>julien@palard.fr</email>
  39                         </author>
  40                 </authorgroup>
  41         </refentryinfo>
  42
  43         <refmeta>
  44                 <refentrytitle>isutf8</refentrytitle>
  45                 <manvolnum>1</manvolnum>
  46                 <refmiscinfo class="manual">moreutils</refmiscinfo>
  47                 <refmiscinfo class="source">moreutils</refmiscinfo>
  48         </refmeta>
  49
  50         <refnamediv>
  51                 <refname>isutf8</refname>
  52                 <refpurpose>check whether files are valid UTF-8</refpurpose>
  53         </refnamediv>
  54
  55         <refsynopsisdiv>
  56                 <cmdsynopsis>
  57                         <command>isutf8</command>
  58                         <arg><option>-hqliv</option></arg>
  59                         <arg><option>--help</option></arg>
  60                         <arg><option>--quiet</option></arg>
  61                         <arg><option>--list</option></arg>
  62                         <arg><option>--invert</option></arg>
  63                         <arg><option>--verbose</option></arg>
  64                         <group choice="opt">
  65                                         <arg rep="repeat"><replaceable>file</replaceable></arg>
  66                         </group>
  67                 </cmdsynopsis>
  68         </refsynopsisdiv>
  69
  70         <refsect1>
  71                 <title>DESCRIPTION</title>
  72
  73                 <para><command>isutf8</command> checks whether files are
  74                 syntactically valid UTF-8. Input is either files named on the
  75                 command line, or the standard input. Notices about files with
  76                 invalid UTF-8 are printed to standard output.</para>
  77
  78         </refsect1>
  79
  80         <refsect1>
  81                 <title>OPTIONS</title>
  82
  83                 <variablelist>
  84
  85                 <varlistentry>
  86                         <term><option>-h</option></term>
  87                         <term><option>--help</option></term>
  88                         <listitem>
  89                                         <para>Print out a help summary.</para>
  90                         </listitem>
  91                 </varlistentry>
  92
  93                 <varlistentry>
  94                         <term><option>-q</option></term>
  95                         <term><option>--quiet</option></term>
  96                         <listitem>
  97                                 <para>Don't print messages telling which files are
  98                                 invalid UTF-8, merely indicate it with the exit
  99                                 status.</para>
 100                         </listitem>
 101                 </varlistentry>
 102
 103                 <varlistentry>
 104                         <term><option>-l</option></term>
 105                         <term><option>--list</option></term>
 106                         <listitem>
 107                                 <para>Print only the names of files containing invalid
 108                                 UTF-8.</para>
 109                         </listitem>
 110                 </varlistentry>
 111
 112                 <varlistentry>
 113                         <term><option>-i</option></term>
 114                         <term><option>--invert</option></term>
 115                         <listitem>
 116                                 <para>Invert the selection: list UTF-8 compatible
 117                                 files.</para>
 118                         </listitem>
 119                 </varlistentry>
 120
 121                 <varlistentry>
 122                         <term><option>-v</option></term>
 123                         <term><option>--verbose</option></term>
 124                         <listitem>
 125                                 <para>Also print an hexdump-like view of the error and some
 126                                 context.</para>
 127                         </listitem>
 128                 </varlistentry>
 129
 130                 </variablelist>
 131
 132         </refsect1>
 133
 134         <refsect1>
 135                 <title>EXIT STATUS</title>
 136
 137                 <para>If the file is valid UTF-8, the exit status is zero.
 138                         If the file is not valid UTF-8, or there is some
 139                         error, the exit status is non-zero.</para>
 140
 141         </refsect1>
 142
 143         <refsect1>
 144                 <title>AUTHOR</title>
 145
 146                 <para>
 147                         Lars Wirzenius, Julien Palard
 148                 </para>
 149         </refsect1>
 150
 151         <refsect1>
 152                 <title>SEE ALSO</title>
 153
 154                 <para>
 155                         <citerefentry>
 156                                 <refentrytitle>utf8</refentrytitle><manvolnum>7</manvolnum>
 157                         </citerefentry>
 158                 </para>
 159
 160         </refsect1>
 161 </refentry>