Permalink
Browse files

Updated README

  • Loading branch information...
tomas committed Jan 3, 2012
1 parent 64955dc commit ec84a21f05bf7e0dd0f2a635e36fcd5b77c846d4
Showing with 13 additions and 13 deletions.
  1. +13 −13 README.md
View
@@ -2,7 +2,7 @@
These modules provide the core functionality for the Prey Bash client.
They are run when triggered remotely, either the official Control Panel
-(panel.preyproject.com) or through the [Standalone Panel](/prey/standalone-control-panel).
+(panel.preyproject.com) or through the [Standalone Panel](/prey/prey-standalone-control-panel).
# How they work
@@ -11,9 +11,9 @@ directory, so in essence the only needed thing for a module to run is that
file. However, Prey will also load additional scripts in case they are found
in the module's path. These are:
-/[module_name]/config -> For keeping settings
-/[module_name]/functions -> Shared functions
-/[module_name]/platform/{mac,linux,windows}/functions -> Platform-specific functions
+ - /[module_name]/config -> For keeping settings
+ - /[module_name]/functions -> Shared functions
+ - /[module_name]/platform/{mac,linux,windows}/functions -> Platform-specific functions
This way you can separate shared logic from that which is platform specific.
@@ -24,18 +24,18 @@ Since they are called in the context of the running script (the main core logic)
modules can access all variables previously defined by Prey. The most useful
ones are:
-$os (linux, mac or windows)
-$root_path
-$users_path
-$home_path
-$tmpbase
-$tmpdir (random directory created by Prey for storing temporary data)
-$logged_user
+ - $os (linux, mac or windows)
+ - $logged_user
+ - $root_path
+ - $users_path
+ - $home_path
+ - $tmpbase
+ - $tmpdir (random directory created by Prey for storing temporary data)
Additionally, Prey will also provide modules with utility variables for modules:
-$module_path: /[module_name]/
-$module_platform_path: /[module_name]/platform/{mac,linux,windows}
+ - $module_path: /[module_name]/
+ - $module_platform_path: /[module_name]/platform/{mac,linux,windows}
# Available functions

0 comments on commit ec84a21

Please sign in to comment.