Mirrors
/
zfsnap
mirror of https://github.com/zfsnap/zfsnap.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[IMP] Improve the manpage for better crontab clarity, closes #115

master
Peter Preeper 2023-10-27 12:07:15 -06:00
parent 2d590e2c82
commit 010c2ee550
1 changed files with 23 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
man/man8/zfsnap.8
View File

@ -271,14 +271,31 @@ exits 0 on success and 1 if an error occurs.
.Sh EXAMPLES
.Nm
was designed to work with cron. Thus, some of these examples will include cron
markup.
markup. Provide concrete values for minute (m), hour (h), day of month (dom),
month (m), and day of week (dow) or use '*' in these fields (for 'any').
.Pp
Every hour, create recursive snapshots of an entire pool and keep for 5 days.
Every hour, on the hour, create recursive snapshots of an entire pool and keep for 5 days.
.Bd -literal -offset indent
# Minute Hour Day Month Day Who Command
5 * * * * root /sbin/zfsnap snapshot \-a 5d \-r zpool
# m h dom mon dow who command
0 * * * * root /sbin/zfsnap snapshot \-a 5d \-r zpool
.Ed
.Pp
Every 20 minutes, create recursive snapshots of an entire pool and keep for 5 days.
.Bd -literal -offset indent
# m h dom mon dow who command
*/20 * * * * root /sbin/zfsnap snapshot \-a 5d \-r zpool
.Ed
.Pp
Every 2 hours, at 10 minutes after, create recursive snapshots of an entire pool and keep for 5 days.
.Bd -literal -offset indent
# m h dom mon dow who command
10 */2 * * * root /sbin/zfsnap snapshot \-a 5d \-r zpool
.Ed
.Pp
.Cm Caution
Make sure that the minute value is specified, otherwise you will create a snapshot
every minute the larger crontime matches.
.Pp
Create snapshots of different datasets in different zpools and keep for 2 weeks.
.Pp
.Dl zfsnap snapshot \-a 2w zpool2/git zpool2/jails \-r zpool2/jails/main zpool1/var
@ -310,8 +327,8 @@ Deleting ZFS snapshots is much slower than creating them, and it's usually not
a problem if snapshots live a few hours longer. Thus, it is usually best to
delete old snapshots once a day.
.Bd -literal -offset indent
# Minute Hour Day Month Day Who Command
0 1 * * * root /sbin/zfsnap destroy \-r zpool
# m h dom mon dow who command
0 1 * * * root /sbin/zfsnap destroy \-r zpool
.Ed
.
.Sh SEE ALSO