improve documentation for 2.0 about zfsnap HOT 5 OPEN

As a matter of fact, I am said newbie and would really like to install and use zfsnap, but have really no clue at all how to install this.

First I tried to copy the manpage to the .../man/man8/ folder and run man zfsnap, but the output looks like crap (no linefeeds, etc.) so that is not the way to go I guess...

Now I guess that I can copy the sbin/* files to /sbin, but with the other folders I have no clue.

So I can do nothing but totally agree with the comment above and hope that someday someone will write a short writeup how to install this. I mean, this might really be a good script, but if you can't install it, people are not really encouraged to use it - and that might be a shame...

from zfsnap.

Thanks for the feedback. Writing a makefile is on my todo list.

BTW, which OS are you on? I'm surprised the man page didn't render well. It's mandoc, so some linux's /might/ struggle, but I have yet to see one.

---Alex

from zfsnap.

Hi,

Thanks for the reply. The OS is Omni-OS (uname -a: SunOS omni-server 5.11
omnios-8c08411 i86pc i386 i86pc)

The output of the file looks like (direct copy/paste from terminal - from
start):

| creates and deletes rolling ZFS snapshots [em] usually with

cron. main advantages are its portability and that all informa-

tion needed for snapshot management is kept in the snapshot name

itself. zfsnap snapshots are in the format of

pool/fs@[prefix]Timestamp--TimeToLive The prefix is optional and

is quite useful for filtering; Timestamp is the date and time

when the snapshot was created; and TimeToLive (TTL) is the amount

of time the snapshot will be kept until it's ready for deletion.

The majority of functionality is implemented at the layer. How-

ever, a few options can be passed to directly. Print a summary

of command[hy]line options and then exit. Print the version

number and exit. operates only on snapshots and will destroy or

create a pool or filesystem. Most actions are performed by using

a All options and arguments passed to a are operated on as they

are read This provides the flexibility needed for complex

scenarios, but also has the capacity to bite you if you're not

paying attention. Remember, is provided for a reason. Only one

can be passed per invocation of By default, will only delete

snapshots whose TTLs have expired. However, options are provided

to override that behaviour with more aggressive approaches. Only

snapshots created by will be considered for deletion. Delete all

zfsnap snapshots [em] regardless of their TTL expiration [em] on

all ZFS file systems that follow this switch. Force delete all

snapshots in all pools exceeding regardless of their TTL expira-

tion. See for more information. Print a summary of

command[hy]line options and then exit. Dry[hy]run. Perform a

trial run with no actions actually performed. Use for snapshots

after this switch. Don't use a prefix for snapshots after this

switch. Operate recursively for snapshots on all ZFS file sys-

tems that follow this switch. Do not operate recursively for

snapshots on all ZFS file systems that follow this switch. Skip

pools that are resilvering. Skip pools that are scrubbing. Ver-

bose output. The purpose of is simple: to create snapshots. Set

how long the snapshot should be kept. If not set, the default is

one month. See for more information. Print a summary of

command[hy]line options and then exit. Dry[hy]run. Perform a

trial run with no actions actually performed. Use for snapshots

after this switch. Don't use a prefix for snapshots after this

switch. Create recursive snapshots of all ZFS file systems that

follow this switch. Create non[hy]recursive snapshots for each

ZFS file system that follows this switch. Skip pools that are

resilvering. Skip pools that are scrubbing. Verbose output.

Round snapshot creation time down to 00 seconds. The

This was the result of:

• copying the man8/zfsnap.8 file to the corresponding man directory
• executing "man zfsnap"

It makes no difference whether I execute it in 'screen' or directly from
the terminal.

It must be noted that both times, I ran it from within a ssh session, ran
from the OSX client (standard terminal, standard ssh implementation).

Cheers,

Jeroen

On Mon, Feb 23, 2015 at 4:12 PM, Alex Waite [email protected]
wrote:

Thanks for the feedback. Writing a makefile is on my todo list.

BTW, which OS are you on? I'm surprised the man page didn't render well.
It's mandoc, so some linux's /might/ struggle, but I have yet to see one.

---Alex

—
Reply to this email directly or view it on GitHub
#54 (comment).

De niet-brutalen hebben de andere helft...

from zfsnap.

@Bimmerboy I can't reproduce your problem with the manpage on OmniOS. Granted the man program is a bit odd in OmniOS, so to view the manpage when it's not installed yet do: MANPATH=man/ man zfsnap

But both man and mandoc correctly render the manpage.

Is this this a problem for you?

---Alex

from zfsnap.

@Bimmerboy I elected not to write a make file, but I did write some documentation in an INSTALL file, to make things a bit easier on those installing by hand.

If you follow it and still have questions, let me know, and I'll do my best to improve the documentation further. :-)

---Alex

from zfsnap.