From c108b443d3b45d04c5a20cf7ff6dac7d182981a1 Mon Sep 17 00:00:00 2001 From: James Vasile Date: Tue, 22 Feb 2011 13:33:35 -0500 Subject: [PATCH] Adding script capability --- doc/scripts.mdwn | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 doc/scripts.mdwn diff --git a/doc/scripts.mdwn b/doc/scripts.mdwn new file mode 100644 index 000000000..da9e65ba3 --- /dev/null +++ b/doc/scripts.mdwn @@ -0,0 +1,24 @@ +# Scripts + +The Plinth front end should not directly change any aspect of the +underlying operating system. Instead, it should call upon scripts, +either by shell command or (for python modules) via import. + +Scripts live in `/scripts`. They should have the following +characteristics: + +* Do only one thing + +* Require no interaction beyond passing parameters or commandline + arguments + +* Change the operation of the services and applications of the Freedom + Plug and nothing else. + +* If a script is a python file, it should be *both* usable from the + commandline and importable as a python module. + +The scripts should be of general utility. They should be usable to +admin and configure the system even in the absence of Plinth. These +scripts are the only supported method of making changes to a Freedom +Plug, whtether by SSH or via Plinth.