aboutsummaryrefslogtreecommitdiffstats
path: root/docs/redo-ifcreate.1.ronn
diff options
context:
space:
mode:
authorTharre <tharre3@gmail.com>2015-04-04 01:52:14 +0200
committerTharre <tharre3@gmail.com>2015-04-04 01:52:14 +0200
commit04cf7c6351f0802899d2cb5d8552b2a4b1c08acf (patch)
treeb0673a9916ecb706b6d1b61de76d2fd8348d1ae0 /docs/redo-ifcreate.1.ronn
parent91bef81e00a7e289509125686418a97c591eb459 (diff)
downloadredo-04cf7c6351f0802899d2cb5d8552b2a4b1c08acf.tar.gz
redo-04cf7c6351f0802899d2cb5d8552b2a4b1c08acf.tar.xz
redo-04cf7c6351f0802899d2cb5d8552b2a4b1c08acf.zip
Add basic man pages for documentation
Diffstat (limited to 'docs/redo-ifcreate.1.ronn')
-rw-r--r--docs/redo-ifcreate.1.ronn35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/redo-ifcreate.1.ronn b/docs/redo-ifcreate.1.ronn
new file mode 100644
index 0000000..365feae
--- /dev/null
+++ b/docs/redo-ifcreate.1.ronn
@@ -0,0 +1,35 @@
+redo-ifcreate(1) -- rebuild if target is created
+================================================
+
+## SYNOPSIS
+
+`redo-ifcreate` [<targets>...]
+
+## DESCRIPTION
+
+`redo-ifcreate` creates a 'on create' dependency on the given (nonexistent)
+<targets>. Should any of those be created in the future, then
+`REDO_PARENT_TARGET` (usually the target that is being built by the .do script)
+is flagged out-of-date.
+
+If any of the <targets> already exist `redo-ifcreate` will return a nonzero exit
+code.
+
+This command should usually be called from within a .do script. See redo(1).
+
+## EXAMPLES
+
+(none yet)
+
+## ENVIRONMENT
+
+Requires `REDO_PARENT_TARGET` and `REDO_ROOT` to be defined. See redo(1) for a
+description of these variables.
+
+## SEE ALSO
+
+redo-ifchange(1), redo-always(1)
+
+## REDO
+
+Part of the redo(1) suite.