summaryrefslogtreecommitdiff
path: root/isutf8.docbook
blob: f4631b2023616931670a8050227058291dda19a9 (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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
<?xml version="1.0" encoding="utf-8"?>

<!--

Copyright 2006 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>
		<authorgroup>
			<author>
				<firstname>Lars</firstname>
				<surname>Wirzenius</surname>
				<email>liw@iki.fi</email>
			</author>
			<author>
				<firstname>Julien</firstname>
				<surname>Palard</surname>
				<email>julien@palard.fr</email>
			</author>
		</authorgroup>
	</refentryinfo>

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

	<refnamediv>
		<refname>isutf8</refname> 
		<refpurpose>check whether files are valid UTF-8</refpurpose>
	</refnamediv>

	<refsynopsisdiv>
		<cmdsynopsis>
			<command>isutf8</command>
			<arg><option>-hqliv</option></arg>
			<arg><option>--help</option></arg>
			<arg><option>--quiet</option></arg>
			<arg><option>--list</option></arg>
			<arg><option>--invert</option></arg>
			<arg><option>--verbose</option></arg>
			<group choice="opt">
					<arg rep="repeat"><replaceable>file</replaceable></arg>
			</group>
		</cmdsynopsis>
	</refsynopsisdiv>
	
	<refsect1>
		<title>DESCRIPTION</title>
		
		<para><command>isutf8</command> checks whether files are
		syntactically valid UTF-8. Input is either files named on the
		command line, or the standard input. Notices about files with
		invalid UTF-8 are printed to standard output.</para>
		
	</refsect1>
	
	<refsect1>
		<title>OPTIONS</title>
		
		<variablelist>
		
		<varlistentry>
			<term><option>-h</option></term>
			<term><option>--help</option></term>
			<listitem>
					<para>Print out a help summary.</para>
			</listitem>
		</varlistentry>
		
		<varlistentry>
			<term><option>-q</option></term>
			<term><option>--quiet</option></term>
			<listitem>
				<para>Don't print messages telling which files are
				invalid UTF-8, merely indicate it with the exit
				status.</para>
			</listitem>
		</varlistentry>

		<varlistentry>
			<term><option>-l</option></term>
			<term><option>--list</option></term>
			<listitem>
				<para>Print only the names of files containing invalid
				UTF-8.</para>
			</listitem>
		</varlistentry>

		<varlistentry>
			<term><option>-i</option></term>
			<term><option>--invert</option></term>
			<listitem>
				<para>Invert the selection: list UTF-8 compatible
				files.</para>
			</listitem>
		</varlistentry>

		<varlistentry>
			<term><option>-v</option></term>
			<term><option>--verbose</option></term>
			<listitem>
				<para>Also print an hexdump-like view of the error and some
				context.</para>
			</listitem>
		</varlistentry>

		</variablelist>
		
	</refsect1>
	
	<refsect1>
		<title>EXIT STATUS</title>
		
		<para>If the file is valid UTF-8, the exit status is zero.
			If the file is not valid UTF-8, or there is some
			error, the exit status is non-zero.</para>
		
	</refsect1>
	
	<refsect1>
		<title>AUTHOR</title>

		<para>
			Lars Wirzenius, Julien Palard
		</para>
	</refsect1>
	
	<refsect1>
		<title>SEE ALSO</title>
		
		<para>
			<citerefentry>
				<refentrytitle>utf8</refentrytitle><manvolnum>7</manvolnum>
			</citerefentry>
		</para>
		
	</refsect1>
</refentry>