CFV

cat

cat [-rREVNO] {ITEM}

Show the data contents of the specified ITEM. By default, the latest version of the items is given; a different version can be selected by using the -r option, with a single revision number.

The data contents is defined as:

diff

diff [-rREVNO] [-l] {ITEM...}

Shows the difference between two versions of the arguments given. By default, the diff is made between the latest revision in the repository and the current version (in the filesystem).

The diff command can also be used to check which items have been modified, by using the -l. In this case, the output will just contain the names of the items which are different between the revisions selected, one item per line.

For each item, the diff output has two parts, each optional. If the item's version differ in data contents, an unified diff over the two versions will be shows. If the versions differ in metadata, an unified diff over a textual representation of the metadata will be shown.

export

export [-r[REVFIRST:]REVNO] [-FFORMAT] [-oFILENAME]

Exports the content of the repository. The export format can be "tar" or "sha1sum" (the default).

The contents of the repository can be exported at a certain revision, using the -rREVNO (which includes also older items modified before that revision); or with an exact set of revisions, with the -rREVFIRST:REVNO, which includes only the items changed in those revisions.

The output destination can be specified with the -o option. The default is standard output, which cand also be specifically denoted using "-" as the destination.

find

find [-l] [-d] [-rREVNO] [--name=SHELL-GLOB] [--regex=REGEX]

The find command searches the contents of the repository.

Tests available:

• select only the items which are available in revision N by using the -rN options (note that this selects all items with revisions <=N).

• select only items which have a certain name by using the --name=SHELL-GLOB option or the --regex=REGEX option. These options filter on the filename using either a shell glob (see glob(7)) or a regular expression (see regex(7)). Note that these options as additive, i.e. if both given they will both filter, making the output more restrictive.

Output control: by default, the listing format is one item name per line, but it can be changed using the options -l and -d.

The -d show an expanded format with informations like:

	    -------------------------
	    Item: id #1, name /etc
	    Created at: 2003-10-13T21:33:17+0
	    Has revisions: [1,]
 
	    -------------------------
	    Item: id #92, name /etc/.pwd.lock
	    Created at: 2003-10-13T21:33:18+0
	    Has revisions: [1,2]

The -l option shows an 'ls -l' like format, with the following fields:

1. mode representation (e.g. -rwxrwxrwx)

2. number of revisions in the repository

3. owner registered in last version

4. group registered in last version

5. size of item's last version

6. time, in ISO format: YYYY-MM-DD HH:MM:SS

7. name

log

log [-rREVNO[:REVNO]] {ITEM...}

The log command shows the log messages of the repository. By default, the full log is shown, however you can restrict the log to a revision or a range of revisions using the -r option with one or two arguments. The one argument form will restrict the output to only one revision, while the two-argument form will restrict the output to all revisions between those given (inclusive).

You can also restrict the log messages to some items by giving them as arguments to the command.

The final set of the revisions show is the intersection of the set of selected revisions (using -r) and the set computed as the union of the revisions numbers of the items given.

retrieve

retrieve [-rREVNO] [-dDIRECTORY] [-n] [-s] [-q] {ITEM...}

The retrieve command restores the given items to the filesystem. By default, the latest version in the repository is restored; use -rREVNUM to restore another version.

A message is shown for each item restored; this can be disabled using the -q option.

By default, the items are restored to their original location; this behavior can be modified using the -d and -s switches.

Also by default, any items given which are directories will be processed recursively, restoring all items which can be reached starting with them. To disable this behavior, use the -n option.

The -dDIRECTORY option can be used to change to top directory of the restore process: for example, the item /etc/passwd can be restored under /tmp/etc/passwd by giving the option -d/tmp.

The -s option can be used to disable the restoration of paths from the filenames. With the above example, to restore the file /etc/passwd to /tmp/passwd you can use the command line cfv -d/tmp -s /etc/passwd. Note that using just -s alone, all files will be restored under /.

Note that the estoration process will not be able to restore the ctime of any items. This is by design in the POSIX filesystem layer: the ctime is for metadata modifications, and the mtime/atime pair for data write/read accesses. Thus a ctime modification would trigger a ctime modification, since the ctime itself is part of metadata, rendering useless the ctime modification :). A read attribute for the metadata would be innapropriate, IMHO, because such reads are made in a great amount. The list of other restrictions in the restore process follows:

stat

stat [-rREVNO] [ITEM...]

The 'stat' command displays information about the metadata of the given items (or all items in the repository), as recorded when they were stored in the repository.

By default, information about the latest revision is given, however you can select a certain revision by passing the -rREVNO option.

The output is formatted to look like the output of the command line utility stat from GNU coreutils.

store

store [-n] [-mMESSAGE] [-cCOMMITER] [-q] {ITEM...}

The store command adds some new items to the repository or stores a new version of the items, if they have been modified. Note that if none items can't be read, the operation will abort; with at least one item successfully read, the operation will continue, generating warnings for items with problems.

A log message is shown for each item being stored; to disable this, use the -q option.

By default, if an item is a directory, all files underneath it will be stored recursively; to disable this behavior, pass the -n option.

The log message must be given using the -m option.

Information about the commiter can be given using the -c option. This should be used with something like 'cron-autocommit', or 'pre-upgrade-autocommit', since cfvers is designed to also run in automated mode; here the uid/gid would be 0 always, so we wouldn't get useful information from there. By default, the commiter string is equal to the login name of the user.