Go to main content

man pages section 5: File Formats

Exit Print View

Updated: Wednesday, February 10, 2021
 
 

fsexam(5)

Name

fsexam - fsexam dry run result file

Description

fsexam dry run result file is an UTF-8 encoded file that stores the dry run result which is produced by invocation of fsexamc(1) with –n option.

You can edit this file directly using any of your favorite editors as long as it supports UTF-8. After editing it, you can re-run fsexamc(1) utility with this file as its input, using –d option. fsexamc(1) will perform conversions based on the supplied file by choosing the first candidates to perform conversions. Refer to fsexamc(1) for more detail.

Note the only recommended edit operations are either deleting wrong candidate lines or adding the correct ones as the first candidates.

This file has the following format. Each items are delimitered by using one or more of white space characters including tab (0x9) and space (0x20) characters:

convert_type

"path"

encoding1 string_converted_from_this_encoding encoding2 string_converted_from_this_encoding encoding3 string_converted_from_this_encoding

"path"

encoding1 string_converted_from_this_encoding encoding2 string_converted_from_this_encoding

"path"

No-proper-encoding

The descriptions on the above like the following:

convert_type

The first line is the conversion type; it is either "name" for name conversion or "content" for content conversion.

Any leading or trailing white space characters including tab (0x9) and space (0x20) are ignored.

path

The full path name of a file for conversion.

If the path itself is a valid UTF-8 byte sequence, then, the path is the actual path name and fsexamc does not do any further processing on it. If the path is not a valid UTF-8 sequence, then, fsexamc converts the path to an URI and shows the URI. Refer to RFC2396 for more information on the URI.

The path is quoted with '"'. Any double-quote character in path is escaped as '\"', and any '\' in path is escaped as '\\'.

encoding1, encoding2, ...

Encoding names. fsexamc converts file name or content from this encoding to UTF-8.

The allowed encodings can be listed with "fsexamc -l" as described in fsexamc(1).

string_converted_from_this_encoding

If this is file name conversion, it is a file name in UTF-8 converted from the encoding shown; if this is file content conversion, it is a single sample line of the file in UTF-8 converted from the encoding which contain at least one or more multi-byte characters.

Note that some lines may contain meaningless characters that you might want to pay no attention and just delete leaving only the right one as the only or the first candidate.

If none of the encodings available yield any correct conversion, that means the real encoding of the file name or content is not in the list of the available encodings. In this case, the following sole line appears in the dry run result file:

        No-proper-encoding

If you do not know anything about the encoding of the file name or content, use –a option of fsexamc to detect encodings automatically. Note that auto-detected encodings may still be wrong in some circumstances.

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
storage/fsexam
Interface Stability
Committed

See Also

fsexamc(1)