Add Document from TortoiseSVN 15285

[tortoisegit/TortoiseGitJp.git] / doc / test / subwcrev2.txt

diff --git a/doc/test/subwcrev2.txt b/doc/test/subwcrev2.txt
new file mode 100644 (file)
index 0000000..93eca2a
--- /dev/null
+++ b/doc/test/subwcrev2.txt
@@ -0,0 +1,49 @@
+SubWCRev  -  A Working Copy Status Tool for Subversion\r
+------------------------------------------------------\r
+\r
+SubWCRev is Windows console program which can be used to read the status\r
+of a Subversion working copy and optionally perform keyword substitution\r
+in a template file.\r
+\r
+usage: SubWCRev WorkingCopyPath [SrcVersionFile] [DstVersionFile] [-n|-d]\r
+\r
+Params:\r
+WorkingCopyPath    :   path to a Subversion working copy\r
+SrcVersionFile     :   path to a template header file\r
+DstVersionFile     :   path to where to save the resulting header file\r
+-n                 :   if given, then SubWCRev will error if the working\r
+                       copy contains local modifications\r
+-d                 :   if given, then SubWCRev will only do its job if\r
+                       DstVersionFile does not exist\r
+\r
+\r
+SubWCRev reads the Subversion status of all files in a working copy, excluding\r
+externals. It records the highest revision number found, and the commit\r
+timestamp of that revision, and also whether there are local modifications in\r
+the working copy. The revision number and mod status are displayed on stdout.\r
+\r
+If a source and destination files are supplied, SubWCRev copies source\r
+to destination, performing keyword substitution as follows:\r
+\r
+$WCREV$ is replaced with the highest version number in the working copy.\r
+\r
+$WCDATE$ is replaced with the commit date/time of that revision in\r
+international format, ie. yyyy-mm-dd hh:mm:ss\r
+\r
+$WCMODS?TrueText:FalseText$ is replaced with TrueText if there are\r
+local modifications, or FalseText if not.\r
+\r
+$WCURL$ is replaced with the repository URL of the working copy path\r
+passed to SubWCRev.\r
+\r
+Finally, an optional switch may be added to abort SubWCRev if certain\r
+conditions are not met.\r
+\r
+The -d switch causes SubWCRev to abort with ERRORLEVEL 8 if the destination\r
+file already exists.\r
+\r
+-------------------------------------------------------------------------------\r
+SubWCRev was written by Stefan Küng for the TortoiseSVN project.\r
+Visit our website at http://tortoisesvn.tigris.org\r
+-------------------------------------------------------------------------------\r
+\r