Login | Register
My pages Projects Community openCollabNet

Discussions > commits > svn commit: r1591 - trunk/fsvs: doc src

fsvs
Discussion topic

Back to topic list

svn commit: r1591 - trunk/fsvs: doc src

Author pmarek
Full name P.Marek
Date 2008-04-06 02:43:38 PDT
Message Author: pmarek
Date: 2008-04-06 02:43:38-0700
New Revision: 1591

Modified:
   trunk/fsvs/doc/USAGE
   trunk/fsvs/doc/fsvs-options.5
   trunk/fsvs/doc/fsvs.1
   trunk/fsvs/src/doc.g-c

Log:
New doxygen run brings new documentation.

Modified: trunk/fsvs/doc/USAGE
Url: http://fsvs.tigris.o​rg/source/browse/fsv​s/trunk/fsvs/doc/USA​GE?view=diff&rev​=1591&p1=trunk/f​svs/doc/USAGE&p2​=trunk/fsvs/doc/USAG​E&r1=1590&r2​=1591
====================​====================​====================​==================
--- trunk/fsvs/doc/USAGE (original)
+++ trunk/fsvs/doc/USAGE 2008-04-06 02:43:38-0700
@@ -391,10 +391,6 @@
    If you're currently in /etc , you can even drop the /etc/ in front, and
    just use the filenames.
 
- This extended path handling on the commandline is not yet available for
- every command. Most of them still expect you to be in the working copy
- root.
-
    Please see status for explanations on -v and -C . For advanced backup
    usage see also FSVS_PROP_COMMIT_PIPE.
 
@@ -917,7 +913,7 @@
 
    This is normally not needed; the use cases are
      * debugging and
- * recovering from data loss in $FSVS_WAA (/var/spool/fsvs ).
+ * recovering from data loss in $FSVS_WAA.
 
    It is (currently) important if you want to backup two similar machines.
    Then you can commit one machine into a subdirectory of your repository,

Modified: trunk/fsvs/doc/fsvs-options.5
Url: http://fsvs.tigris.o​rg/source/browse/fsv​s/trunk/fsvs/doc/fsv​s-options.5?view=dif​f&rev=1591&p​1=trunk/fsvs/doc/fsv​s-options.5&p2=t​runk/fsvs/doc/fsvs-o​ptions.5&r1=1590​&r2=1591
====================​====================​====================​==================
--- trunk/fsvs/doc/fsvs-options.5 (original)
+++ trunk/fsvs/doc/fsvs-options.5 2008-04-06 02:43:38-0700
@@ -1,4 +1,4 @@
-.TH "Further options for FSVS." 1 "1 Apr 2008" "Version trunk:2078" "fsvs" \" -*- nroff -*-
+.TH "Further options for FSVS." 1 "6 Apr 2008" "Version trunk:1496" "fsvs" \" -*- nroff -*-
 .ad l
 .nh
 .SH NAME
@@ -15,32 +15,9 @@
 .IP "\(bu" 2
 \fCconflict\fP - \fBHow to resolve conflicts on update\fP
 .IP "\(bu" 2
-\fCcopyfrom_exp\fP - \fBAvoiding expensive compares on \fBcopyfrom-detect\fP\fP
-.IP "\(bu" 2
-\fCdebug_output\fP - \fBDestination for debug output\fP
-.IP "\(bu" 2
-\fCdelay\fP - \fBWaiting for a time change after working copy operations\fP
-.IP "\(bu" 2
-\fCdiff_prg\fP, \fCdiff_opt\fP, \fCdiff_extra\fP - \fBOptions relating to the 'diff' action\fP
-.IP "\(bu" 2
-\fCdir_sort\fP - \fBDirectory sorting\fP
-.IP "\(bu" 2
-\fCempty_commit\fP - \fBDoing empty commits\fP
-.IP "\(bu" 2
-\fCfilter\fP - \fBFiltering entries\fP, but see \fB-f\fP.
-.IP "\(bu" 2
-\fClog_output\fP - \fB'fsvs log' output format\fP
-.IP "\(bu" 2
-\fCmerge_prg\fP, \fCmerge_opt\fP - \fBOptions regarding the 'merge' programm\fP
-.IP "\(bu" 2
-\fCpath\fP - \fBDisplaying paths\fP
-.IP "\(bu" 2
-\fCsoftroot\fP - \fBUsing an alternate root directory\fP
-.IP "\(bu" 2
-\fCstat_color\fP - \fBStatus output coloring\fP
-.IP "\(bu" 2
-\fCwarning\fP - \fBSetting warning behaviour\fP, but see \fB-W\fP.
+\fCconf\fP - \fBPath definitions for the config and WAA area\fP.
 .PP
+\fCcopyfrom_exp\fP - \fBAvoiding expensive compares on \fBcopyfrom-detect\fP\fP \fCdebug_output\fP - \fBDestination for debug output\fP \fCdelay\fP - \fBWaiting for a time change after working copy operations\fP \fCdiff_prg\fP, \fCdiff_opt\fP, \fCdiff_extra\fP - \fBOptions relating to the 'diff' action\fP \fCdir_sort\fP - \fBDirectory sorting\fP \fCempty_commit\fP - \fBDoing empty commits\fP \fCfilter\fP - \fBFiltering entries\fP, but see \fB-f\fP. \fClog_output\fP - \fB'fsvs log' output format\fP \fCmerge_prg\fP, \fCmerge_opt\fP - \fBOptions regarding the 'merge' programm\fP \fCpath\fP - \fBDisplaying paths\fP \fCsoftroot\fP - \fBUsing an alternate root directory\fP \fCstat_color\fP - \fBStatus output coloring\fP \fCwarning\fP - \fBSetting warning behaviour\fP, but see \fB-W\fP. \fCwaa\fP - \fBo_waa\fP.
 .SH "Priorities for option setting"
 .PP
 The priorities are
@@ -235,12 +212,12 @@
 .IP "\(bu" 2
 \fCno\fP, \fCoff\fP or \fCfalse:\fP Don't use \fCcolordiff\fP.
 .IP "\(bu" 2
-\fCyes\fP, \fCtrue\fP or \fCon:\fP If this option is set on the commandline, or the output is a tty, pipe the output of the \fCdiff\fP program (see \fBOptions relating to the 'diff' action\fP) to \fCcolordiff\fP.
+'', ie. empty (default value): Try to use \fCcolordiff\fP as executable, but don't throw an error if it can't be started; just pipe the data as-is to \fCSTDOUT\fP.
 .IP "\(bu" 2
-\fCauto:\fP Like yes, but don't throw an error if colordiff can't be started; just pipe the data as-is to \fCSTDOUT\fP.
+anything else: Pipe the output of the \fCdiff\fP program (see \fBOptions relating to the 'diff' action\fP) to the given executable.
 .PP
 .PP
-The default value is \fCauto\fP.
+Please note that if \fCSTDOUT\fP is not a tty (eg. is redirected into a file), this option must be given on the command line to take effect.
 .SH "Filtering entries"
 .PP
 Please see the command line parameter for \fB-f\fP, which is identical.
@@ -453,6 +430,22 @@
 
 .fi
 .PP
-
+.SH "Path definitions for the config and WAA area"
+.PP
+.PP
+The path given here is used to store the persistent configuration data needed by FSVS; please see \fBFiles used by fsvs\fP and \fBPriorities for option setting\fP for more details, and the \fBUsing an alternate root directory\fP parameter as well as the \fBRecovery for a non-booting system\fP for further discussion.
+.PP
+.PP
+.nf
+ FSVS_CONF=/home/user/.fsvs-conf fsvs -o waa=/home/user/.fsvs-waa st
+.fi
+.PP
+.PP
+\fBNote:\fP
+.RS 4
+Please note that these paths can be given \fBonly\fP as environment variables (\fC$FSVS_CONF\fP resp. \fC$FSVS_WAA\fP) or as command line parameter; settings in config files are ignored.
+.RE
+.PP
+
 .PP
 

Modified: trunk/fsvs/doc/fsvs.1
Url: http://fsvs.tigris.o​rg/source/browse/fsv​s/trunk/fsvs/doc/fsv​s.1?view=diff&re​v=1591&p1=trunk/​fsvs/doc/fsvs.1&​p2=trunk/fsvs/doc/fs​vs.1&r1=1590​&r2=1591
====================​====================​====================​==================
--- trunk/fsvs/doc/fsvs.1 (original)
+++ trunk/fsvs/doc/fsvs.1 2008-04-06 02:43:38-0700
@@ -1,4 +1,4 @@
-.TH "Commands and command line parameters" 1 "1 Apr 2008" "Version trunk:2078" "fsvs" \" -*- nroff -*-
+.TH "Commands and command line parameters" 1 "6 Apr 2008" "Version trunk:1496" "fsvs" \" -*- nroff -*-
 .ad l
 .nh
 .SH NAME
@@ -328,8 +328,6 @@
 .PP
 If you're currently in \fC/etc\fP , you can even drop the \fC/etc/\fP in front, and just use the filenames.
 .PP
-This extended path handling on the commandline is not yet available for every command. Most of them still expect you to be in the working copy root.
-.PP
 Please see \fBstatus\fP for explanations on \fC-v\fP and \fC-C\fP . For advanced backup usage see also \fBFSVS_PROP_COMMIT_PIPE\fP.
 .PP
  
@@ -819,7 +817,7 @@
 .IP "\(bu" 2
 debugging and
 .IP "\(bu" 2
-recovering from data loss in \fC$FSVS_WAA\fP (\fC/var/spool/fsvs\fP ).
+recovering from data loss in \fB$FSVS_WAA\fP.
 .PP
 .PP
 It is (currently) important if you want to backup two similar machines. Then you can commit one machine into a subdirectory of your repository, make a copy of that directory for another machine, and sync this other directory on the other machine.

Modified: trunk/fsvs/src/doc.g-c
Url: http://fsvs.tigris.o​rg/source/browse/fsv​s/trunk/fsvs/src/doc​.g-c?view=diff&r​ev=1591&p1=trunk​/fsvs/src/doc.g-c​&p2=trunk/fsvs/src/​doc.g-c&r1=1590​&r2=1591
====================​====================​====================​==================
--- trunk/fsvs/src/doc.g-c (original)
+++ trunk/fsvs/src/doc.g-c 2008-04-06 02:43:38-0700
@@ -1,5 +1,5 @@
 /* This file is generated, do not edit!
- * Last done on Tue Apr 1 13:06:50 2008
+ * Last done on Sun Apr 6 09:25:53 2008
  * */
 
 
@@ -72,10 +72,6 @@
   " If you're currently in /etc , you can even drop the /etc/ in front, and\n"
   " just use the filenames.\n"
   "\n"
- " This extended path handling on the commandline is not yet available for\n"
- " every command. Most of them still expect you to be in the working copy\n"
- " root.\n"
- "\n"
   " Please see status for explanations on -v and -C . For advanced backup\n"
   " usage see also FSVS_PROP_COMMIT_PIPE.\n"
   "\n";
@@ -529,7 +525,7 @@
   "\n"
   " This is normally not needed; the use cases are\n"
   " * debugging and\n"
- " * recovering from data loss in $FSVS_WAA (/var/spool/fsvs ).\n"
+ " * recovering from data loss in $FSVS_WAA.\n"
   "\n"
   " It is (currently) important if you want to backup two similar machines.\n"
   " Then you can commit one machine into a subdirectory of your repository,\n"

« Previous message in topic | 1 of 1 | Next message in topic »

Messages

Show all messages in topic

svn commit: r1591 - trunk/fsvs: doc src pmarek P.Marek 2008-04-06 02:43:38 PDT
Messages per page: