| FSVS - Options and configfile(5) | fsvs | FSVS - Options and configfile(5) |
Further options for FSVS. -
List of settings that modify FSVS' behaviour. List of settings that modify FSVS' behaviour.
FSVS understands some options that modify its behaviour in various small ways.
This document lists all available options in FSVS, in an full listing and in groups.
Furthermore you can see their relative priorities and some examples.
FSVS currently knows:
The priorities are
Note:
Furthermore there are 'intelligent' run-time dependent settings, like turning off colour output when the output is redirected. Their priority is just below the command line - so they can always be overridden if necessary.
Using the commandline:
fsvs -o path=environment
fsvs -opath=environment
Using environment variables:
FSVS_PATH=absolute fsvs st
A configuration file, from $FSVS_CONF/config or in a WC-specific path
below $FSVS_CONF:
# FSVS configuration file
path=wcroot
If you remove a directory, all entries below are implicitly known to be deleted, too. To make the status output shorter there's the all_removed option which, if set to no, will cause children of removed entries to be omitted.
Example for the config file:
all_removed=no
When this option is enabled, directories where only the mtime changed are not reported on status anymore.
This is useful in situations where temporary files are created in directories, eg. by text editors. (Example: VIM swapfiles when no directory option is configured).
Example for the config file:
dir_exclude_mtime=yes
If you'd like to have the output of status sorted, you can use the option dir_sort=yes. FSVS will do a run through the tree, to read the status of the entries, and then go through it again, but sorted by name.
Note:
Please see the command line parameter for -f, which is identical.
fsvs -o filter=mtime
There are some defaults for the number of revisions that are shown on a 'fsvs log' command:
As this option can only be used to set an upper limit of revisions, it makes most sense for the no-revision-arguments case.
You can modify aspects of the fsvs log output format by setting the log_output option to a combination of these flags:
Note:
Furthermore the value normal is available; this turns off all special handling.
Note:
You can specify how paths printed by FSVS should look like; this is used for the entry status output of the various actions, and for the diff header lines.
There are several possible settings, of which one can be chosen via the path option.
Note:
The next two are nearly identical to absolute, but the beginning of paths are substituted by environment variables. This makes sense if you want the advantage of full paths, but have some of them abbreviated.
Note:
Only environment variables whose names start with WC are used for substitution, to avoid using variables like $PWD, $OLDPWD, $HOME and similar which might differ between sessions. Maybe the allowed prefixes for the environment variables should be settable in the configuration. Opinions to the users mailing list, please.
Example, with / as working copy base:
$ cd /etc $ fsvs -o path=wcroot st $ fsvs -o path=absolute st $ fsvs -o path=parameters st $ fsvs -o path=parameters st . $ fsvs -o path=parameters st / $ fsvs -o path=parameters st X11 $ fsvs -o path=parameters st ../dev/.. $ fsvs -o path=parameters st X11 ../etc $ fsvs -o path=parameters st ../etc X11 $ fsvs -o path=environ st $ WCBAR=/etc fsvs -o path=wcroot st $ WCBAR=/etc fsvs -o path=wcroot st / $ WCBAR=/e fsvs -o path=wcroot st $ WCBAR=/etc WCFOO=/etc/X11 fsvs -o path=wcroot st $ touch /etc/X11/xinit/xinitrc $ fsvs -o path=parameters st $ fsvs -o path=parameters st X11 /etc/X11/xinit
Note:
FSVS can colorize the output of the status lines; removed entries will be printed in red, new ones in green, and otherwise changed in blue. Unchanged (for -v) will be given in the default color.
For this you can set stat_color=yes; this is turned off per default.
As with the other colorizing options this gets turned off automatically if the output is not on a tty; on the command line you can override this, though.
If you want to use FSVS in scripts, you might simply want to know whether anything was changed.
In this case use the stop_on_change option, possibly combined with Filtering entries; this gives you no output on STDOUT, but an error code on the first change seen:
fsvs -o stop_change=yes st /etc
if fsvs status -o stop_change=yes -o filter=text /etc/init.d
then
echo No change found ...
else
echo Changes seen.
fi
If you want a bit more control about the data you're getting you can use some specific flags for the verbose options.
Please note that if you want to display fewer items than per default, you'll have to clear the bitmask first, like this:
fsvs status -o verbose=none,changes,path
The diff is not done internally in FSVS, but some other program is called, to get the highest flexibility.
There are several option values:
The call is done as
$diff_prg $diff_opt $file1 --label '$label1' $file2 --label '$label2' $diff_extra
Note:
Advanced users might be interested in exported environment variables, too; with their help you can eg. start different diff programs depending on the filename.
If you have colordiff installed on your system, you might be interested in the colordiff option.
It can take one of these values:
Please note that if STDOUT is not a tty (eg. is redirected into a file), this option must be given on the command line to take effect.
If you start an update, but one of the entries that was changed in the repository is changed locally too, you get a conflict.
There are some ways to resolve a conflict:
The conflict must be solved manually, and the solution made known to FSVS via the resolve command.
Note:
If it is a clean merge, no further work is necessary; else you'll get the (partly) merged file, and the two other versions just like with the both variant, and (again) have to tell FSVS that the conflict is solved, by using the resolve command.
Note:
Like with diff, the merge operation is not done internally in FSVS.
To have better control
The option '-p' is always used:
$merge_prg $merge_opt -p $file1 $common $file2
You can specify an author to be used on commit. This option has a special behaviour; if the first character of the value is an '$', the value is replaced by the environment variable named.
Empty strings are ignored; that allows an /etc/fsvs/config like this:
author=unknown
author=$LOGNAME
author=$SUDO_USER
where the last non-empty value is taken; and if your .authorized_keys has
lines like
environment='FSVS_AUTHOR=some_user' ssh-rsa ...
that would override the config values.
Note:
If you defined multiple URLs for your working copy, FSVS needs to know which URL to commit to.
For this you would set commit_to to the name of the URL; see this example:
fsvs urls N:master,P:10,http://... N:local,P:20,file:///...
fsvs ci /etc/passwd -m 'New user defined' -ocommit_to=local
In the default settings FSVS will happily create empty commits, ie. revisions without any changed entry. These just have a revision number, an author and a timestamp; this is nice if FSVS is run via CRON, and you want to see when FSVS gets run.
If you would like to avoid such revisions, set this option to no; then such commits will be avoided.
Example:
fsvs commit -o empty_commit=no -m 'cron' /etc
If you don't like the behaviour that FSVS does commits with an empty message received from $EDITOR (eg if you found out that you don't want to commit after all), you can change this option to no; then FSVS won't allow empty commit messages.
Example for the config file:
empty_message=no
If you want to keep some data versioned, the first commit is normally the creation of the base directories above the given URL (to keep that data separate from the other repository data).
Previously this had to be done manually, ie. with a svn mkdir $URL
--parents or similar command.
With the mkdir_base option you can tell FSVS to create directories as
needed; this is mostly useful on the first commit.
fsvs urls ...
fsvs group 'group:ignore,./**'
fsvs ci -m 'First post!' -o mkdir_base=yes
If you're using FSVS in automated systems, you might see that changes that happen in the same second as a commit are not seen with status later; this is because the timestamp granularity of FSVS is 1 second.
For backward compatibility the default value is no (don't delay). You can set it to any combination of
for yes all of these actions are delayed until the clock seconds change.
Example how to set that option via an environment variable:
export FSVS_DELAY=commit,revert
This options allows one to specify the trade-off between speed and accuracy.
A file with a changed size can immediately be known as changed; but if only the modification time is changed, this is not so easy. Per default FSVS does a MD5 check on the file in this case; if you don't want that, or if you want to do the checksum calculation for every file (in case a file has changed, but its mtime not), you can use this option to change FSVS' behaviour.
On the command line there's a shortcut for that: for every '-C' another check in this option is chosen.
The recognized specifications are noneResets the check bitmask to 'no checks'. file_mtimeCheck files for modifications (via MD5) and directories for new entries, if the mtime is different - default dirCheck all directories for new entries, regardless of the timestamp. allfilesCheck all files with MD5 for changes (tripwire -like operation). fullAll available checks.
You can give multiple options; they're accumulated unless overridden by none.
fsvs -o change_check=allfiles status
Note:
If you've got big files that are seen as new, doing the MD5 comparison can be time consuming. So there's the option copyfrom_exp (for 'expensive', which takes the usual yes (default) and no arguments.
fsvs copyfrom-detect -o copyfrom_exp=no some_directory
If you need to ignore many entries of your working copy, you might
find that the ignore pattern matching takes some valuable time.
In order to optimize the order of your patterns you can specify this option
to print the number of tests and matches for each pattern.
$ fsvs status -o group_stats=yes -q
Grouping statistics (tested, matched, groupname, pattern):
4705 80 ignore group:ignore,.
For optimizing you'll want to put often matching patterns at the front (to make them match sooner, and avoid unnecessary tests); but if you are using other groups than ignore (like take), you will have to take care to keep the patterns within a group together.
Please note that the first line shows how many entries were tested, and that the next lines differ by the number of matches entries for the current line, as all entries being tested against some pattern get tested for the next too, unless they match the current pattern.
This option is available for status and the ignore test commands.
The paths given here are used to store the persistent configuration data needed by FSVS; please see Files used by fsvs and Priorities for option setting for more details, and the Using an alternate root directory parameter as well as the Recovery for a non-booting system for further discussion.
FSVS_CONF=/home/user/.fsvs-conf fsvs -o waa=/home/user/.fsvs-waa st
Note:
This path specifies where the subversion libraries should take their configuration data from; the most important aspect of that is authentication data, especially for certificate authentication.
The default value is $FSVS_CONF/svn/.
/etc/fsvs/config could have eg.
config_dir=/root/.subversion
Please note that this directory can hold an auth directory, and the servers and config files.
This is a path that is prepended to $FSVS_WAA and $FSVS_CONF (or their default values, see Files used by fsvs), if they do not already start with it, and it is cut off for the directory-name MD5 calculation.
When is that needed? Imagine that you've booted from some Live-CD like Knoppix; if you want to setup or restore a non-working system, you'd have to transfer all files needed by the FSVS binary to it, and then start in some kind of chroot environment.
With this parameter you can tell FSVS that it should load its libraries from the current filesystem, but use the given path as root directory for its administrative data.
This is used for recovery; see the example in Recovery for a non-booting system.
So how does this work?
Previously you'd have to export your data back to the filesystem and call urls 'fsvs urls' and FSVS sync-repos again, to get the WAA data back.
Note:
The easy way to understand softroot is: If you want to do a chroot() into the given directory (or boot with it as /), you'll want this set.
As this value is used for finding the correct working copy root (by trying to find a conf-path, it cannot be set from a per-wc config file. Only the environment, global configuration or command line parameter make sense.
The next two options could be set in the global configuration file, to automatically get the last debug messages when an error happens.
To provide an easy way to get on-line debugging again, debug_output and debug_buffer are both reset to non-redirected, on-line output, if more than a single -d is specified on the command line, like this:
fsvs commit -m '...' -d -d filenames
In this case you'll get a message telling you about that.
You can specify the debug output destination with the option debug_output. This can be a simple filename (which gets truncated on open), or, if it starts with a |, a command that the output gets piped into.
If the destination cannot be opened (or none is given), debug output goes to STDOUT (for easier tracing via less).
Example:
fsvs -o debug_output=/tmp/debug.out -d st /etc
Note:
An example: writing the last 200 lines of debug output into a file.
fsvs -o debug_output='| tail -200 > /tmp/debug.log' -d ....
With the debug_buffer option you can specify the size of a buffer (in kB) that is used to capture the output, and which gets printed automatically if an error occurs.
This must be done before debugging starts, like with the debug_output specification.
fsvs -o debug_buffer=128 ...
Note:
Please see the command line parameter -W, which is identical.
fsvs -o warning=diff-status=ignore
Generated automatically by Doxygen for fsvs from the source code.
| 11 Mar 2010 | Version trunk:2424 |