cshatag.1

.\"Generate README file for github: MANWIDTH=80 man ./cshatag.1 > README
.TH CSHATAG 1 "MAY 2012" Linux "User Manuals"
.SH NAME

cshatag \- compiled shatag

.SH SYNOPSIS

cshatag [OPTIONS] FILE [FILE...]

.SH DESCRIPTION

cshatag is a minimal and fast re-implementation of shatag
.br
( https://github.com/maugier/shatag , written in Python
by Maxime Augier )
.br
in a compiled language (since v2.0: Go, earlier versions: C).

cshatag is a tool to detect silent data corruption. It writes
the mtime and the sha256 checksum of a file into the file's
extended attributes. The filesystem needs to be mounted with
user_xattr enabled for this to work.
When run again, it compares stored mtime and checksum. If it
finds that the mtime is unchanged but the checksum has changed,
it warns on stderr and reports a <corrupt> status.
In any case, the status of the file is printed to stdout.

File statuses that appear on stdout are:
.br
	<new>         file is missing both attributes
.br
	<outdated>    both mtime and checksum have changed
.br
	<ok>          both checksum and mtime stayed the same
.br
	<timechange>  only mtime has changed, checksum stayed the same
.br
	<corrupt>     mtime stayed the same but checksum changed

When a file is considered <corrupt>, the stored checksum is
only updated if "-fix" is passed. For all other statuses
except <ok>, the stored checksum is always updated.

cshatag aims to be format-compatible with shatag and uses the
same extended attributes (see the COMPATIBILITY section).

cshatag was written in C in 2012 and has been
rewritten in Go in 2019.

.SH OPTIONS

-cpuprofile save cpu profile to specified file. This is useful
            for diagnosing performance issues.
.br
-dry-run    don't make any changes
.br
-fix        fix the stored sha256 on corrupt files
.br
-j          number of threads. Values <= 0 means auto
            (https://pkg.go.dev/github.com/charlievieth/fastwalk#DefaultNumWorkers).
.br
-q          quiet mode - don't report <ok> files
.br
-qq         quiet2 mode - only report <corrupt> files and errors
.br
-recursive  recursively process the contents of directories
.br
-remove     remove cshatag's xattrs from FILE


.SH EXAMPLES

Check all regular files in the file tree below the current working directory:
.br
# cshatag -qq -recursive .
.br
Errors like corrupt files will be printed to stderr.
Run without "-qq" to see progress output.

To remove the extended attributes from all files:
.br
# cshatag -recursive -remove .

.SH "RETURN VALUE"

0 Success
.br
1 Wrong number of arguments
.br
2 One or more files could not be opened
.br
3 One or more files is not a regular file
.br
4 Extended attributes could not be written to one or more files
.br
5 At least one file was found to be corrupt
.br
6 More than one type of error occurred

.SH COMPATIBILITY

cshatag writes the user.shatag.ts field with full integer
nanosecond precision, while python uses a double for the
whole mtime and loses the last few digits.

.SH AUTHOR
Jakob Unterwurzacher <jakobunt@gmail.com>
.br
https://github.com/rfjakob/cshatag

.SH COPYRIGHT
Copyright 2012 Jakob Unterwurzacher. MIT License.

.SH "SEE ALSO"
shatag(1), sha256sum(1), getfattr(1), setfattr(1)