.\" Copyright 2011 Lars Wirzenius <liw@liw.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 3 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, see <http://www.gnu.org/licenses/>.
.\"
.TH FSCK-LARCH 1
.SH NAME
fsck-larch \- verify that a larch B-tree is internally consistent
.SH SYNOPSIS
.nh
.B fsck\-larch
.RB [ \-\-config\fR=\fIFILE ]
.RB [ \-\-dump\-config ]
.RB [ \-\-dump\-memory\-profile\fR=\fIMETHOD ]
.RB [ \-\-dump\-setting\-names ]
.RB [ \-\-fix ]
.RB [ \-\-generate\-manpage\fR=\fITEMPLATE ]
.RB [ \-h ]
.RB [ \-\-help ]
.RB [ \-\-help\-all ]
.RB [ \-\-list\-config\-files ]
.RB [ \-\-log\fR=\fIFILE ]
.RB [ \-\-log\-keep\fR=\fIN ]
.RB [ \-\-log\-level\fR=\fILEVEL ]
.RB [ \-\-log\-max\fR=\fISIZE ]
.RB [ \-\-log\-mode\fR=\fIMODE ]
.RB [ \-\-memory\-dump\-interval\fR=\fISECONDS ]
.RB [ \-\-no\-default\-configs ]
.RB [ \-\-no\-fix ]
.RB [ \-\-output\fR=\fIFILE ]
.RB [ \-\-trace\fR=\fIPATTERN ]
.RB [ \-\-version ]
.RI [ FILE ]... ""
.hy
.SH DESCRIPTION
.B fsck-larch
reads an on-disk, committed B-tree created by the
.B larch
Python library,
and verifies that it is internally consistent.
It reports any problems it finds,
but does not currently fix them.
.SH OPTIONS
.TP
.BR \-\-fix
fix problems found?
.TP
.BR \-\-generate\-manpage =\fITEMPLATE
SUPPRESSHELP
.TP
.BR \-h ", " \-\-help
show this help message and exit
.TP
.BR \-\-no\-fix

.TP
.BR \-\-output =\fIFILE
write output to FILE, instead of standard output
.TP
.BR \-\-trace =\fIPATTERN
add PATTERN to trace patterns
.TP
.BR \-\-version
show program's version number and exit
.SS "Configuration files and settings"
.TP
.BR \-\-config =\fIFILE
add FILE to config files
.TP
.BR \-\-dump\-config
write out the entire current configuration
.TP
.BR \-\-dump\-setting\-names
SUPPRESSHELP
.TP
.BR \-\-help\-all
show all options
.TP
.BR \-\-list\-config\-files
SUPPRESSHELP
.TP
.BR \-\-no\-default\-configs
clear list of configuration files to read
.SS "Logging"
.TP
.BR \-\-log =\fIFILE
write log entries to FILE (default is to not write log files at all); use "syslog" to log to system log, or "none" to disable logging
.TP
.BR \-\-log\-keep =\fIN
keep last N logs (10)
.TP
.BR \-\-log\-level =\fILEVEL
log at LEVEL, one of debug, info, warning, error, critical, fatal (default: debug)
.TP
.BR \-\-log\-max =\fISIZE
rotate logs larger than SIZE, zero for never (default: 0)
.TP
.BR \-\-log\-mode =\fIMODE
set permissions of new log files to MODE (octal; default 0600)
.SS "Peformance"
.TP
.BR \-\-dump\-memory\-profile =\fIMETHOD
make memory profiling dumps using METHOD, which is one of: none, simple, or meliae (default: simple)
.TP
.BR \-\-memory\-dump\-interval =\fISECONDS
make memory profiling dumps at least SECONDS apart
.SH "SEE ALSO"
Larch home page
.RI ( http://liw.fi/larch/ ).