sanoid/packages/debian/sanoid.8

67 lines
1.7 KiB
Groff

.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH SANOID "8" "February 2024" "sanoid version 2.2.0" "System Administration Utilities"
.SH NAME
sanoid \- manual page for sanoid version 2.2.0
.SH DESCRIPTION
.SS "Usage:"
.IP
sanoid [options]
.IP
Assumes \fB\-\-cron\fR \fB\-\-verbose\fR if no other arguments (other than configdir)
are specified
.IP
Options:
.TP
\fB\-\-configdir\fR=\fI\,DIR\/\fR
Specify a directory to find config file sanoid.conf
.TP
\fB\-\-cache\-dir\fR=\fI\,DIR\/\fR
Specify a directory to store the zfs snapshot cache
.TP
\fB\-\-run\-dir\fR=\fI\,DIR\/\fR
Specify a directory for temporary files such as lock files
.TP
\fB\-\-cron\fR
Creates snapshots and purges expired snapshots
.TP
\fB\-\-verbose\fR
Prints out additional information during a sanoid run
.TP
\fB\-\-readonly\fR
Simulates creation/deletion of snapshots
.TP
\fB\-\-quiet\fR
Suppresses non\-error output
.TP
\fB\-\-force\-update\fR
Clears out sanoid's zfs snapshot cache
.TP
\fB\-\-monitor\-health\fR
Reports on zpool "health", in a Nagios compatible format
.TP
\fB\-\-monitor\-capacity\fR
Reports on zpool capacity, in a Nagios compatible format
.TP
\fB\-\-monitor\-snapshots\fR
Reports on snapshot "health", in a Nagios compatible format
.TP
\fB\-\-take\-snapshots\fR
Creates snapshots as specified in sanoid.conf
.TP
\fB\-\-prune\-snapshots\fR
Purges expired snapshots as specified in sanoid.conf
.TP
\fB\-\-force\-prune\fR
Purges expired snapshots even if a send/recv is in progress
.TP
\fB\-\-help\fR
Prints this helptext
.TP
\fB\-\-version\fR
Prints the version number
.TP
\fB\-\-debug\fR
Prints out a lot of additional information during a sanoid run
.PP
(Getopt::Long::GetOptions version 2.52; Perl version 5.36.0)