[pkg-fso-commits] [nodm] 01/01: Reformatted README as markdown
Enrico Zini
enrico at enricozini.org
Sat Feb 27 15:34:27 UTC 2016
This is an automated email from the git hooks/post-receive script.
enrico pushed a commit to branch master
in repository nodm.
commit 921db7e4223e28e01a7523230305c595fd7a8b67
Author: Enrico Zini <enrico at enricozini.org>
Date: Sat Feb 27 16:34:23 2016 +0100
Reformatted README as markdown
---
README => README.md | 80 ++++++++++++++++++++++++-----------------------------
1 file changed, 36 insertions(+), 44 deletions(-)
diff --git a/README b/README.md
similarity index 55%
rename from README
rename to README.md
index ba62624..5c84c10 100644
--- a/README
+++ b/README.md
@@ -1,5 +1,3 @@
- * README for nodm
-
nodm is a minimal display manager that simply logs in as a given user and
starts an X session, without asking for username or password.
@@ -12,7 +10,7 @@ panel for industrial machinery. For those cases, nodm is simple to setup,
lightweight, and it should do exactly the right thing.
- * Features
+## Features
nodm is as small as it could be, and tries to provide the minimum amount of
features needed to do a good job, following as much as possible the principle
@@ -44,47 +42,41 @@ This is not a particular design choice: quite simply, so far no one has felt
the need to implement it.
- * Configuration
+## Configuration
Configuration is made via 5 environment variables:
-NODM_USER
- Controls the user that is used to automatically log in.
-
-NODM_X_OPTIONS
- X server command line (for example: "vt7 -nolisten tcp").
-
- It is expanded using wordexp, with tilde expansion, variable substitution,
- arithmetic expansion, wildcard expansion and quote removal, but no command
- substitution. If command substitution is needed, please get in touch
- providing a real-life use case for it.
-
- If the first optiom starts with '/' or '.', it is used as the X server, else
- "X" is used as the server.
-
- If the second option (or the first if the first was not recognised as a path
- to the X server) looks like ":<NUMBER>", it is used as the display name, else
- ":0" is used.
-
- If the command line contains a "vt<N>" virtual terminal indicator, automatic
- VT allocation is switched off. Otherwise, the appropriate vt<N> option is
- appended to the X command line according to the virtual terminal that has
- been allocated.
-
-NODM_MIN_SESSION_TIME
- Minimum time (in seconds) that a session should last in order for nodm to
- decide that it has not quit too soon. If an X session runs for less than
- this time, nodm will wait an increasing amount of time before restarting it
- (default: 60).
-
-NODM_XSESSION
- X session command (default: /etc/X11/Xsession). It is run using the shell, so
- it can be any shell command.
-
-NODM_XINIT
- Was used by older versions of nodm as the path to the xinit program, but it
- is now ignored.
-
-NODM_X_TIMEOUT
- Timeout (in seconds) to wait for X to be ready to accept connections. If X is
- not ready before this timeout, it is killed and restarted.
+ * `NODM_USER`:
+ Controls the user that is used to automatically log in.
+ * `NODM_X_OPTIONS`:
+ X server command line (for example: "vt7 -nolisten tcp").
+ It is expanded using wordexp, with tilde expansion, variable substitution,
+ arithmetic expansion, wildcard expansion and quote removal, but no command
+ substitution. If command substitution is needed, please get in touch
+ providing a real-life use case for it.
+
+ If the first optiom starts with '/' or '.', it is used as the X server, else
+ "X" is used as the server.
+
+ If the second option (or the first if the first was not recognised as a path
+ to the X server) looks like ":<NUMBER>", it is used as the display name, else
+ ":0" is used.
+
+ If the command line contains a "vt<N>" virtual terminal indicator, automatic
+ VT allocation is switched off. Otherwise, the appropriate vt<N> option is
+ appended to the X command line according to the virtual terminal that has
+ been allocated.
+ * `NODM_MIN_SESSION_TIME`:
+ Minimum time (in seconds) that a session should last in order for nodm to
+ decide that it has not quit too soon. If an X session runs for less than
+ this time, nodm will wait an increasing amount of time before restarting it
+ (default: 60).
+ * `NODM_XSESSION`:
+ X session command (default: /etc/X11/Xsession). It is run using the shell, so
+ it can be any shell command.
+ * `NODM_XINIT`
+ Was used by older versions of nodm as the path to the xinit program, but it
+ is now ignored.
+ * `NODM_X_TIMEOUT`
+ Timeout (in seconds) to wait for X to be ready to accept connections. If X is
+ not ready before this timeout, it is killed and restarted.
--
Alioth's hooks/post-receive on /srv/git.debian.org/git/pkg-fso/nodm.git
More information about the pkg-fso-commits
mailing list