Permalink
Browse files

added path docs

  • Loading branch information...
1 parent ea25377 commit b3a5ca9f4a899feed6bb7416516f39708f2be123 Ines Sombra committed Nov 28, 2011
Showing with 69 additions and 3 deletions.
  1. +1 −1 bin/paths/copy
  2. +1 −1 bin/paths/move
  3. +1 −1 bin/paths/remove
  4. +66 −0 man/man1/apidoc_paths.1
View
@@ -7,7 +7,7 @@ set -v # Turn on verbose logging, so that the following will present a tutorial.
# Now we will create a path
path create /tmp/paths/copy/example
-# We can change permissions of the path and make it read only
+# We can copy the given path from origin to destination.
path copy from /tmp/paths/copy/example to /tmp/paths/copy/example_v2
# Let's see the paths,
View
@@ -10,7 +10,7 @@ path create /tmp/paths/move/example
# Let's see the path and it's contents,
ls -l /tmp/paths/move_*
-# We can change permissions of the path and make it read only
+# Moves origin path to destination path
path move from /tmp/paths/move/example to /tmp/paths/move/example_v2
# Let's see the renamed path and it's contents,
View
@@ -11,7 +11,7 @@ path create /tmp/paths/remove
ls -l /tmp/paths/
-# We can remove a path,
+# We can remove a path
path remove /tmp/paths/remove
# Check to make sure that the 'remove' path has been removed,
@@ -0,0 +1,66 @@
+.TH SM 1 "2011 November 27" "SM Framework"
+
+.SH SYNOPSIS
+.B sm
+{options...} paths action {action-params}
+
+.SH DESCRIPTION
+S{cripting,ystem} Manager (SM) Framework (Core) API files documentation
+
+.SH Installation
+To load the files module API, add 'api/paths' to the shell/includes file.
+
+.SH Actions
+.TP 13
+.B chmod recursively mode {mode} {path}
+Recursively change the permissions of the given path.
+.TP 13
+.B chown {user} {path}
+Changes the owner of a given path, provided the user executing the script has permissions to do so.
+.TP 13
+.B copy from {origin path} to {destination path}
+Copy the given path from origin to destination.
+.TP 13
+.B create {path}
+Creates a path.
+.TP 13
+.B enter {path}
+Enters a path. Unlike 'cd' this action will emit a backtrace upon failure.
+.TP 13
+.B exist {path}
+Tests for the existence of path.
+.TP 13
+.B expand {path name}
+?
+.TP 13
+.B move {origin path} to {destination path}
+ Moves origin path to destination path.
+.TP 13
+.B remove {path name}
+Removes a path.
+
+
+.SH Options
+.TP 13
+.B --trace={filter}
+Show trace output for functions using specified filter.
+.TP 13
+.B --trace
+Equivalent to
+.B --trace=action
+- show only called action trace.
+.TP 13
+.B --trace=all
+Show trace output for all functions that are not excluded, by default excluded is (
+.B -search
+).
+.TP 13
+.B --debug={filter}
+Show debug messages for given filter.
+.TP 13
+.B --var-debug={variable_name}
+Display changes and stacktrace when the given {variable_name} changes.
+.TP 13
+.B --var-debug-short
+Show only list of functions instead of full stack trace when using
+.B --var-debug={variable_name}

0 comments on commit b3a5ca9

Please sign in to comment.