Home | History | Annotate | Download | only in man4
      1 <!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
      2 <!--ArborText, Inc., 1988-1999, v.4002-->
      3 <!ENTITY cmd "fsexam">
      4 <!ENTITY % commonents SYSTEM "smancommon.ent">
      5 %commonents;
      6 <!ENTITY % booktitles SYSTEM "booktitles.ent">
      7 %booktitles;
      8 <!ENTITY suncopy "Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.">
      9 ]>
     10 <?Pub UDT _bookmark _target>
     11 <?Pub EntList brvbar bull cross dash diam diams frac12 frac13 frac14 hellip
     12  laquo lArr loz mdash nabla ndash para pound rArr raquo sect yen bsol>
     13 <?Pub Inc>
     14 
     15 <refentry id="fsexam-4">
     16 <!-- %Z%%M% %I% %E% SMI; -->
     17 <refmeta><refentrytitle>fsexam</refentrytitle><manvolnum>4</manvolnum>
     18 <refmiscinfo class="date">10 May 2007</refmiscinfo>
     19 <refmiscinfo class="sectdesc">&man4;</refmiscinfo>
     20 <refmiscinfo class="software">&release;</refmiscinfo>
     21 <refmiscinfo class="arch">generic</refmiscinfo>
     22 <refmiscinfo class="copyright">&suncopy;</refmiscinfo>
     23 </refmeta>
     24 
     25 <indexterm><primary>fsexam</primary></indexterm>
     26 <indexterm><primary>fsexam dry run result file</primary></indexterm>
     27 
     28 <refnamediv id="fsexam-4-name"><refname>fsexam</refname>
     29 <refpurpose>fsexam dry run result file</refpurpose></refnamediv>
     30 
     31 <refsect1 id="fsexam-4-desc"><title>&desc-tt;</title>
     32 <para>
     33 fsexam dry run result file is an UTF-8 encoded file that stores the dry
     34 run result which is produced by invocation of fsexam utility with -n option.
     35 
     36 You can edit this file directly using any of your favorite editors as long
     37 as it supports UTF-8. After editing it, you can re-run fsexam utility with
     38 this file as its input, using -d option. fsexam will perform conversions
     39 based on the supplied file by choosing the first candidates to perform
     40 conversions. Refer to fsexam(1) for more detail.
     41 
     42 Note the only recommended edit operations are either deleting wrong
     43 candidate lines or adding the correct ones as the first candidates.
     44 
     45 This file has the following format. Each items are delimitered by
     46 using one or more of white space characters including tab (0x9) and
     47 space (0x20) characters:
     48 
     49 <variablelist termlength="narrow">
     50 
     51 <varlistentry>
     52 <term>convert_type</term>
     53 <listitem>
     54 <para>   
     55 </para>
     56 </listitem>
     57 </varlistentry>
     58 
     59 <varlistentry>
     60 <term>"path"</term>
     61 <listitem>
     62 <para>   
     63 </para>
     64 <para>
     65 encoding1	string_converted_from_this_encoding
     66 encoding2	string_converted_from_this_encoding
     67 encoding3	string_converted_from_this_encoding
     68 </para>
     69 </listitem>
     70 </varlistentry>
     71 
     72 <varlistentry>
     73 <term>"path"</term>
     74 <listitem>
     75 <para>   
     76 </para>
     77 <para>
     78 encoding1	string_converted_from_this_encoding
     79 encoding2	string_converted_from_this_encoding
     80 </para>
     81 </listitem>
     82 </varlistentry>
     83 
     84 <varlistentry>
     85 <term>"path"</term>
     86 <listitem>
     87 <para>   
     88 </para>
     89 <para>
     90 No-proper-encoding
     91 </para>
     92 </listitem>
     93 </varlistentry>
     94 </para>
     95 
     96 </variablelist>
     97 
     98 
     99 <para>
    100 The descriptions on the above like the following:
    101 </para>
    102 
    103 <variablelist termlength="narrow">
    104 
    105 <varlistentry>
    106 <term>convert_type:</term>
    107 <listitem>
    108 <para>   
    109 </para>
    110 <para>
    111 The first line is the conversion type; it is either "name" for name
    112 conversion or "content" for content conversion.
    113 
    114 Any leading or trailing white space characters including tab (0x9)
    115 and space (0x20) are ignored.
    116 </para>
    117 </listitem>
    118 </varlistentry>
    119 
    120 <varlistentry>
    121 <term>path:</term>
    122 <listitem>
    123 <para> 
    124 </para>
    125 <para>
    126 The full path name of a file for conversion. 
    127 
    128 If the path itself is a valid UTF-8 byte sequence, then, the path is
    129 the actual path name and fsexam does not do any further processing on
    130 it. If the path is not a valid UTF-8 sequence, then, fsexam converts
    131 the path to an URI and shows the URI. Refer RFC2396 for more
    132 information on the URI.
    133 
    134 The path is quoted with '"'. Any double-quote character in path is
    135 escaped as '\\"', and any '\\' in path is escaped as '\\\\'.
    136 </para>
    137 </listitem>
    138 </varlistentry>
    139 
    140 <varlistentry>
    141 <term>encoding1, encoding2, ...:</term>
    142 <listitem>
    143 <para> 
    144 </para>
    145 <para>Encoding names. fsexam converts file name or content from this encoding
    146 to UTF-8.
    147 
    148 The allowed encodings can be listed with "fsexam -l" as described in
    149 the fsexam(1).
    150 </para>
    151 </listitem>
    152 </varlistentry>
    153 	
    154 <varlistentry>
    155 <term>string_converted_from_this_encoding:</term>
    156 <listitem>
    157 <para> 
    158 </para>
    159 <para>If this is file name conversion, it is a file name in UTF-8 converted
    160 from the encoding shown; if this is file content conversion, it is
    161 a single sample line of the file in UTF-8 converted from the encoding
    162 which contain at least one or more multi-byte characters.
    163 
    164 Note that some lines may contain meaningless characters that you
    165 might want to pay no attention and just delete leaving only
    166 the right one as the only or the first candidate.
    167 
    168 If none of the encodings available yield any correct conversion,
    169 that means the real encoding of the file name or content is not in
    170 the list of the available encodings. In this case, the following
    171 sole line appears in the dry run result file:
    172 
    173 	No-proper-encoding
    174 
    175 If you do not know anything about the encoding of the file name or
    176 content, use -a option of fsexam to detect encodings automatically. 
    177 Note that auto-detected encodings may still be wrong in some 
    178 circumstances.
    179 </para>
    180 </listitem>
    181 </varlistentry>
    182 
    183 </variablelist>
    184 </refsect1>
    185 
    186 <refsect1 id="fsexam-4-attr"><title>&attr-tt;</title>
    187 <para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
    188 <refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
    189 for descriptions of the following attributes:</para>
    190 <informaltable frame="all">
    191 <tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
    192 <colspec colname="COLSPEC1" colwidth="1*">
    193 <thead>
    194 <row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
    195 valign="middle">ATTRIBUTE VALUE</entry></row>
    196 </thead>
    197 <tbody>
    198 <row><entry><para>Availability</para></entry><entry><para>SUNWfsexam</para></entry>
    199 </row>
    200 <row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
    201 colname="COLSPEC1"><para>Committed</para></entry></row>
    202 </tbody>
    203 </tgroup>
    204 </informaltable>
    205 </refsect1>
    206 <refsect1 id="fsexam-4-also"><title>&also-tt;</title>
    207 <!--Reference to another man page-->
    208 <!--Reference to a Help manual-->
    209 <!--Reference to a book.-->
    210 <para>
    211 <citerefentry><refentrytitle>fsexam</refentrytitle><manvolnum>1</manvolnum>
    212 </citerefentry>
    213 </para>
    214 </refsect1>
    215 </refentry>
    216