about summary refs log tree commit diff
path: root/doc/execline-shell.html
blob: 92140c12361f01d31edc415b56c2410e81ab6057 (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
49
50
51
52
53
54
55
<html>
  <head>
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
 <meta http-equiv="Content-Language" content="en" />
 <title>execline: the execline-shell script</title>
 <meta name="Description" content="execline: the execline-shell script" />
 <meta name="Keywords" content="execline script execline-shell" />
 <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
</head>
<body>

<p>
<a href="index.html">execline</a><br />
<a href="//skarnet.org/software/">Software</a><br />
<a href="//skarnet.org/">skarnet.org</a>
</p>

<h1> The <tt>execline-shell</tt> script </h1>

<p>
<tt>execline-shell</tt> executes <tt>$HOME/.execline-shell</tt>
if available (or <tt>/bin/sh</tt> otherwise) with the arguments
it is given.
</p>

<h2> Interface </h2>

<pre>
     /etc/execline-shell
</pre>

<ul>
 <li> <tt>execline-shell</tt> transforms itself into
<tt>${HOME}/.execline-shell $@</tt>. </li>
 <li><tt>${HOME}/.execline-shell</tt> must be readable and
executable by the user. It must exec into an interactive
shell with <tt>$@</tt> as its argument. </li>
</ul>

<h2> Notes </h2>

<ul>
 <li> <tt>execline-shell</tt> is meant to be used as the <tt>SHELL</tt>
environment variable value. It allows one to specify their favourite shell and
shell configuration in any language, since the <tt>${HOME}/.execline-shell</tt>
file can be any executable program. <tt>${HOME}/.execline-shell</tt> can be seen
as a portable <tt>.<em>whatever</em>rc</tt> file. </li>
 <li> As an administrator-modifiable configuration file, <tt>execline-shell</tt>
is provided in execline's <tt>examples/etc/</tt> subdirectory, and should be copied by
the administrator to <tt>/etc</tt>. </li>
</ul>

</body>
</html>