From 63d42efc9dc3f5cf13856cf08aaa807bfd8982e5 Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Fri, 20 Dec 2013 11:50:21 +0100 Subject: initial commit --- README.md | 45 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 44 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 07c480d..335ca12 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,47 @@ nullshell ========= -do nothing but print asterisks, can be used for login shell +**do nothing but print asterisks, can be used for login shell** + +This is a minimal program that does nothing but print asteriks every now +and then. It is intended to be used for login shell with accounts +accessible via secure shell that are used for secure tunneling but +should not allow to execute commands. + +Requirements +------------ + +To compile and run `nullshell` you need: + +* nothing (this is plain C) +* [markdown](http://daringfireball.net/projects/markdown/) (HTML documentation) + +Additionally it is expected to have `make` and a C compiler around to +successfully compile. + +Build and install +----------------- + +Building and installing is very easy. Just run: + +> make + +followed by: + +> make install + +This will place an executable at `/usr/bin/nullshell`. + +Usage +----- + +To create a new user `user` with `nullshell` as login shell just run: + +> useradd -s /usr/bin/nullshell user + +Or to make `nullshell` the login shell for an existing user `user`: + +> usermod -s /usr/bin/nullshell user + +Make sure `/usr/bin/nullshell` is listed in `/etc/shells` if your system +expects this. -- cgit v1.2.3-54-g00ecf