summaryrefslogtreecommitdiffstats
path: root/modules/pam_namespace/pam_namespace_helper.8.xml
blob: 2f5adbed72dcf9eedc3bb047f37d5ec58e5508b6 (plain)
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
<?xml version="1.0" encoding='UTF-8'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
	"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">

<refentry id="pam_namespace_helper">

  <refmeta>
    <refentrytitle>pam_namespace_helper</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo>
  </refmeta>

  <refnamediv id="pam_namespace_helper-name">
    <refname>pam_namespace_helper</refname>
    <refpurpose>Helper binary that creates home directories</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis id="pam_namespace_helper-cmdsynopsis">
      <command>pam_namespace_helper</command>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id="pam_namespace_helper-description">

    <title>DESCRIPTION</title>

    <para>
      <emphasis>pam_namespace_helper</emphasis> is a helper program
      for the <emphasis>pam_namespace</emphasis> module that sets up a
      private namespace for a session with polyinstantiated
      directories. The helper ensures that the namespace mount points
      exist before they are started to be used for the
      polyinstantiated directories. Mount points for home directories
      (lines with $HOME) are not created.
    </para>

    <para>
      <emphasis>pam_namespace_helper</emphasis> should be run by
      systemd at system startup. It should also be run by the
      administrator after defining the polyinstantiated directories
      but before enabling them.
    </para>
  </refsect1>

  <refsect1 id='pam_namespace_helper-see_also'>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
	<refentrytitle>pam_namespace</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>
    </para>
  </refsect1>

  <refsect1 id='pam_namespace_helper-author'>
    <title>AUTHOR</title>
      <para>
        Written by Topi Miettinen.
      </para>
  </refsect1>

</refentry>