xref: /freebsd/lib/libpam/modules/pam_xdg/pam_xdg.8 (revision 1b9cfd6a625dc82611846cb9a53c1886f7af3758)
1.\" * SPDX-License-Identifier: BSD-2-Clause
2.\"
3.\" Copyright (c) 2024 Beckhoff Automation GmbH & Co. KG
4.\"
5.\" * Redistribution and use in source and binary forms, with or without
6.\" * modification, are permitted provided that the following conditions
7.\" * are met:
8.\" * 1. Redistributions of source code must retain the above copyright
9.\" *    notice, this list of conditions and the following disclaimer.
10.\" * 2. Redistributions in binary form must reproduce the above copyright
11.\" *    notice, this list of conditions and the following disclaimer in the
12.\" *    documentation and/or other materials provided with the distribution.
13.\" *
14.\" * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" * SUCH DAMAGE.
25.Dd August 22, 2024
26.Dt PAM_XDG 8
27.Os
28.Sh NAME
29.Nm pam_xdg
30.Nd XDG PAM module
31.Sh SYNOPSIS
32.Op Ar service-name
33.Ar module-type
34.Ar control-flag
35.Pa pam_xdg
36.Op Ar arguments
37.Sh DESCRIPTION
38The xdg service module for PAM sets up the runtime directory according
39to the XDG specifications.
40.Pp
41By default the directory is created under
42.Pa /var/run/xdg/<username> .
43.Pp
44The following option may be passed to the authentication module:
45.Bl -tag -width ".Cm runtime_dir_prefix"
46.It Cm runtime_dir_prefix Ns = Ns Ar directory
47Use an alternate base directory
48.El
49.Sh SEE ALSO
50.Xr pam 3 ,
51.Xr pam.conf 5
52.Sh AUTHORS
53The
54.Nm
55module and this manual page were written by
56.An Emmanuel Vadot Aq Mt manu@FreeBSD.org .
57