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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "PACLOCK 1"
.TH PACLOCK 1 2024-04-16 pacutils paclock
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
paclock \- lock/unlock the alpm database
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& paclock [options]
\& paclock (\-\-help|\-\-version)
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Safe locking and unlocking of the ALPM database using identity keys for
scripts.
.SH OPTIONS
.IX Header "OPTIONS"
.IP \fB\-\-config\fR=\fIpath\fR 4
.IX Item "--config=path"
Set an alternate configuration file path.
.IP \fB\-\-lockfile\fR=\fIpath\fR 4
.IX Item "--lockfile=path"
Set an alternate lock file path.
.IP \fB\-\-root\fR=\fIpath\fR 4
.IX Item "--root=path"
Set an alternate installation root.
.IP \fB\-\-sysroot\fR=\fIpath\fR 4
.IX Item "--sysroot=path"
Set an alternate system root. See \fBpacutils\-sysroot\fR\|(7).
.IP \fB\-\-lock\fR 4
.IX Item "--lock"
Lock the database (default).
.IP \fB\-\-unlock\fR 4
.IX Item "--unlock"
Unlock the database.
.IP \fB\-\-run\fR 4
.IX Item "--run"
Treat \f(CW\*(C`argv\*(C'\fR as a command to run with the database locked. If the command
returns non-zero, the lock file will be left in place to indicate an error
unless \fB\-\-fail\-ok\fR is used.
.IP \fB\-\-fail\-ok\fR 4
.IX Item "--fail-ok"
Unlock the database after running a command with \fB\-\-run\fR even if the command
returns non-zero. Generally, the database should be left locked if it may be
in an inconsistent to indicate that it may need to be repaired. This flag is
intended primarily for read-only operations.
.IP \fB\-\-print\fR 4
.IX Item "--print"
Write the lock file path to \fIstdout\fR and exit without modifying the lock file.
.IP \fB\-\-no\-check\-keys\fR 4
.IX Item "--no-check-keys"
Skip checking for an identity key match before unlocking.
.IP \fB\-\-enoent\-ok\fR 4
.IX Item "--enoent-ok"
Do not treat a non-existent lock file as an error when unlocking.
.IP \fB\-\-key\fR=\fIidentity\fR 4
.IX Item "--key=identity"
An identifier to write to the lock file. By default, \fB\-\-unlock\fR will only
operate if the lock file was previously locked with the same key. Defaults to
the hostname followed by a colon and the process id of the caller (for example:
\&\f(CW\*(C`localhost:123\*(C'\fR).
.IP \fB\-\-help\fR 4
.IX Item "--help"
Display usage information and exit.
.IP \fB\-\-version\fR 4
.IX Item "--version"
Display version information and exit.
.SH EXAMPLE
.IX Header "EXAMPLE"
The system configuration that \fBpaclock\fR relies on to construct the default
lock file path and identity key may change between invocations. To ensure
consistency, scripts should explicitly provide the path and key to use each
time \fBpaclock\fR is called.
.PP
.Vb 6
\& #!/bin/bash
\& lock_file="$(paclock \-\-print)"
\& lock_key="myapp:$(hostname):$$"
\& paclock \-\-lockfile="$lock_file" \-\-key="$lock_key" || exit 1
\& echo "do stuff here"
\& paclock \-\-lockfile="$lock_file" \-\-key="$lock_key" \-\-unlock || exit 1
.Ve
.PP
Run a command lacking native lock support:
.PP
.Vb 1
\& paclock \-\-run \-\- paccache \-\-dryrun \-\-verbose
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBpacconf\fR\|(1)
|
