From f445ce7b1f73ae05553db03e8537677c8189012e Mon Sep 17 00:00:00 2001 From: Albert S Date: Sun, 11 Aug 2019 12:18:15 +0200 Subject: [PATCH] improved README format --- README.md | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 20a8028..2ea9208 100644 --- a/README.md +++ b/README.md @@ -11,35 +11,38 @@ By default, raou looks in /etc/raou.d/ for config files. If you run "raou backup", it will look for /etc/raou.d/backup. Example config file: - +``` user john target_user root path /usr/local/bin/script.sh +``` +**user** is the name of the user who you want to give permissions to +execute **path** as the **target_user**. -*user* is the name of the user who you want to give permissions to -execute *path* as the *target_user*. - -*path* must contain the absolute path. +**path** must contain the absolute path. Optional fields --------------- -*args*: If you want to leave out optional arguments (argv) to *path*, +**args**: If you want to leave out optional arguments (argv) to *path*, simply don't include this. Otherwise, simply specify them +``` +... args -v -ltr - -*allow_args*: Allow arbitrary arguments, so: +``` +**allow_args**: Allow arbitrary arguments, so: +``` raou backup /path +``` -Will launch "path" as specified in the file for the backup entry, but -with "/path" as argv[1] instead of the arguments specified with "args". +Will launch "path" as specified in the file for the backup entry with "/path" as argv[1] instead of the argument specified with "args" in the config file. -*no_new_privs*: Defaults to 1. Processes launched with this option active +**no_new_privs**: Defaults to 1. Processes launched with this option active won't be able to gain more privileges, even when they call setuid programs. -*env_vars*: A comma-separated list of environment variables to inherit +**env_vars**: A comma-separated list of environment variables to inherit from the current environment. Everything else will be wiped (but others like HOME, SHELL etc. will be appropriately set). -*argv0*: Set this option if you want to provide your own value as "argv0" +**argv0**: Set this option if you want to provide your own value as "argv0" The default is the name of the launched binary (not the whole path).