Skip to content

Commit

Permalink
Minor documentation changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Jehops committed Jun 14, 2016
1 parent 78b7376 commit 0e5c56a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
8 changes: 4 additions & 4 deletions README.org
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
* zap -- Maintain ZFS snapshots with cron [1]

** NOTE: The command line arguments have changed in version 0.3.0!
** WARNING: The command line arguments have changed in version 0.3.0!

** Overview
Run zap without arguments or visit https://github.com/Jehops/zap.
Expand All @@ -24,7 +24,7 @@
Destroy expired snapshots.

** Examples
Create snapshots that will last for 1 day, 3 weeks, 6 months, and 1 year:
Create snapshots that will last for 1 day, 3 weeks, 6 months, and 1 year.

=$ zap 1d zroot/ROOT/default=

Expand All @@ -35,7 +35,7 @@
=$ zap 1y tank/backup=

Create the same snapshots for filesystems with the zap:snap property set to
"on":
"on".

=$ zap 1d=

Expand All @@ -45,7 +45,7 @@

=$ zap 1y=

Destroy expired snapshots:
Destroy expired snapshots.

=$ zap -d=

Expand Down
8 changes: 3 additions & 5 deletions zap
Original file line number Diff line number Diff line change
Expand Up @@ -77,23 +77,21 @@ DESCRIPTION
Destroy expired snapshots.
Run ${0##*/} with no arguments, -h, or --help to show this documentation.
EXAMPLES
Create snapshots that will last for 1 day, 3 weeks, 6 months, and 1 year:
Create snapshots that will last for 1 day, 3 weeks, 6 months, and 1 year.
$ ${0##*/} 1d zroot/ROOT/default
$ ${0##*/} 3w tank zroot/usr/home/nox
$ ${0##*/} 6m zroot/usr/home/jrm zroot/usr/home/mem
$ ${0##*/} 1y tank/backup
Create the same snapshots for filesystems with the zap:snap property set to
"on"
"on".
$ ${0##*/} 1y
$ ${0##*/} 3w
$ ${0##*/} 6m
$ ${0##*/} 1y
Destroy expired snapshots:
Destroy expired snapshots.
$ ${0##*/} -d
AUTHORS AND CONTRIBUTORS
Expand Down

0 comments on commit 0e5c56a

Please sign in to comment.