about summary refs log tree commit diff
path: root/doc/s6-ln.html
blob: 59dbdca9f846c5685a1740fe581d78e667b0044b (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
56
57
58
59
60
61
62
63
64
<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>s6-portable-utils: the s6-ln program</title>
    <meta name="Description" content="s6-portable-utils: the s6-ln program" />
    <meta name="Keywords" content="s6-portable-utils command s6-ln ln link symbolic hard" />
    <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
  </head>
<body>

<p>
<a href="index.html">s6-portable-utils</a><br />
<a href="//skarnet.org/software/">Software</a><br />
<a href="//skarnet.org/">skarnet.org</a>
</p>

<h1> The <tt>s6-ln</tt> program </h1>

<p>
 s6-ln creates a link to a file.
</p>

<h2> Interface </h2>

<pre>
     s6-ln [ -n ] [ -s ] [ -f ] [ -L ] [ -P ] <em>source...</em> <em>target</em>
</pre>

<p>
 s6-ln acts as the generic
<a href="https://pubs.opengroup.org/onlinepubs/9699919799/utilities/ln.html">ln</a> utility.
</p>

<h2> Options </h2>

<ul>
 <li> <tt>-s</tt>&nbsp;: create a symbolic link instead of a hard link </li>
 <li> <tt>-f</tt>&nbsp;: force replacement of an existing <em>target</em> </li>
 <li> <tt>-L</tt>&nbsp;: link targets of symlinks in <em>source...</em> </li>
 <li> <tt>-P</tt>&nbsp;: link symlinks in <em>source...</em> themselves </li>
 <li> <tt>-n</tt>&nbsp;: if <em>target</em> is a symlink to a directory, replace
it instead of adding a link in the directory </li>
</ul>

<h2> Posixness </h2>

<p>
 s6-ln <strong>would be</strong> suitable as a Single Unix
<a href="https://pubs.opengroup.org/onlinepubs/9699919799/utilities/ln.html">ln</a>
program, except that POSIX mandates that a preexisting <em>target</em> must first
be <tt>unlink()</tt>ed and then (<tt>sym</tt>)<tt>link()</tt>ed, which prevents
atomic replacements.
 <tt>s6-ln</tt> aims to be reliable and allow for atomic replacements, so it
deviates from POSIX on that point: when <em>target</em> exists and needs to
be replaced, <tt>s6-ln</tt> first creates a (sym)link to a unique temporary
name, then <tt>rename()</tt>s the temporary name to <em>target</em>. This
behaviour makes sure that <em>target</em> is atomically replaced - there's
no point in time where it does not exist.
</p>

</body>
</html>