summaryrefslogtreecommitdiffstats
path: root/README.md
blob: eea5569a3df469b6444210bdf0b5e08d62de660d (about) (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
nullshell
=========

**do nothing but print keep alive characters, can be used for login shell**

This is a minimal program that does nothing but print some characters
(namely version information and time&date string) 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.