[Getdata-commits] SF.net SVN: getdata:[823] trunk/defile

[<ket...@us...>]

Revision: 823
          http://sourceforge.net/p/getdata/code/823
Author:   ketiltrout
Date:     2013-03-16 01:37:28 +0000 (Sat, 16 Mar 2013)
Log Message:
-----------
Doc updates.

Modified Paths:
--------------
    trunk/defile/bin/defile.c
    trunk/defile/doc/defile.1.in

Modified: trunk/defile/bin/defile.c
===================================================================
--- trunk/defile/bin/defile.c	2013-03-16 01:16:36 UTC (rev 822)
+++ trunk/defile/bin/defile.c	2013-03-16 01:37:28 UTC (rev 823)
@@ -2481,7 +2481,7 @@
       NULL, "turn on asynchronous mode"
     },
     { DF_WOPT_SYNC, DF_OPT_PLUS | DF_OPT_NO_ARG, 'a', "sync", "Synchronous",
-      NULL, "turn off synchronous mode"
+      NULL, "turn off asynchronous mode (default)"
     },
     { DF_WOPT_CLOBBER, DF_OPT_NO_ARG, 0, "clobber", "Clobber", NULL,
       "if the output dirfile already exists, overwrite it; use with caution"

Modified: trunk/defile/doc/defile.1.in
===================================================================
--- trunk/defile/doc/defile.1.in	2013-03-16 01:16:36 UTC (rev 822)
+++ trunk/defile/doc/defile.1.in	2013-03-16 01:37:28 UTC (rev 823)
@@ -208,20 +208,21 @@
 don't overwrite an existing dirfile.  This is the default behaviour. (Directive:
 .BR NoClobber )
 .TP
-.BR \-D ", " \-\-directory=\fIDIR
+.BR \-D ", " \-\-directory=\fIPATH
 unless
 .B \-\-output
 is given and specifies an absolute path, write the output dirfile as a
 subdirectory under
-.IR DIR .
+.IR PATH .
 If
 .B \-\-output
 is not specified, then name of the output dirfile created under
-.B DIR
+.B PATH
 will be provided by the input plugin, or else be based on
 .IR INPUT .
 If
-.B \-\-output does specify an absolute path, this option is ignored.  (Directive:
+.B \-\-output
+does specify an absolute path, this option is ignored.  (Directive:
 .BR Directory )
 .TP
 .BR \-o ", " \-\-output=\fIPATH
@@ -236,22 +237,10 @@
 directories specified in
 .IR PATH .
 Using this option may have averse effects if the input causes defile to cycle as
-explained above.
-.IP
-Some input plugins may trigger defile to create more than one consecutive output
-dirfile (in cases when the input plugin notices a change in the data source
-metadata or name).  When this occurs while using this option, if
-.B \-\-clobber
-has been specified, defile will truncate the old dirfile that it was just
-writing, and overwrite it with a new (empty) one at
-.IR PATH .
-If
-.B \-\-clobber
-has not been specified, defile will exit with an error, having been asked to
-overwrite an existing dirfile.  (Directive:
+explained above.  (Directive:
 .BR Output )
 .TP
-.BR \-\-cut\-dirs= N
+.BI \-\-cut\-dirs= N
 When no output dirfile name is explicitly given, defile will generate one from
 the
 .I INPUT
@@ -271,6 +260,40 @@
 .B \-\-output
 is used to explicitly name the output dirfile.  (Directive:
 .BR CutDirs )
+.TP
+.BR \-S ", " \-\-symlink=\fIPATH
+Create a symlink called
+.I PATH
+(relative to the current directory, if not absolute) pointing to the output
+dirfile.  An existing file or symlink called
+.I PATH
+will be overwritten.  The symlink is updated if the input plugin causes defile
+to cycle between output dirfiles.  The traditional name of the symlink is
+.IR defile.lnk .
+(Directive:
+.BR Symlink )
+.TP
+.BR +S ", " \-\-no\-symlink
+Don't create a symlink.  This is the default behaviour. (Directive:
+.BR NoSymlink )
+.TP
+.BR \-C ", " \-\-curfile=\fIPATH
+Create a text file called
+.I PATH
+(relative to the current directory, if not absolute) containing the full
+pathname of the output dirfile.  An existing file called
+.I PATH
+will be overwritten.  The file is updated (re-written) if the input plugin
+causes defile to cycle between output dirfiles.  In the Dirfile milieu, this
+is known as a "curfile", and can be used as a poor man's symlink.  The
+traditional name of the file is
+.IR defile.cur .
+(Directive:
+.BR CurFile )
+.TP
+.BR +C ", " \-\-no\-curfile
+Don't create a curfile.  This is the default behaviour. (Directive:
+.BR NoCurFile )
 
 .SS Running Mode Options
 The following options affect the modes in which defile runs.

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.