summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man1/paclock.1
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
commitfc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch)
treece1e3bce06471410239a6f41282e328770aa404a /upstream/archlinux/man1/paclock.1
parentInitial commit. (diff)
downloadmanpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz
manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/archlinux/man1/paclock.1')
-rw-r--r--upstream/archlinux/man1/paclock.1228
1 files changed, 228 insertions, 0 deletions
diff --git a/upstream/archlinux/man1/paclock.1 b/upstream/archlinux/man1/paclock.1
new file mode 100644
index 00000000..3d759292
--- /dev/null
+++ b/upstream/archlinux/man1/paclock.1
@@ -0,0 +1,228 @@
+.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
+.\"
+.\" 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
+..
+.\" Set up some character translations and predefined strings. \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote. \*(C+ will
+.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+. ds -- \(*W-
+. ds PI pi
+. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
+. ds L" ""
+. ds R" ""
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds -- \|\(em\|
+. ds PI \(*p
+. ds L" ``
+. ds R" ''
+. 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
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear. Run. Save yourself. No user-serviceable parts.
+. \" fudge factors for nroff and troff
+.if n \{\
+. ds #H 0
+. ds #V .8m
+. ds #F .3m
+. ds #[ \f1
+. ds #] \fP
+.\}
+.if t \{\
+. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+. ds #V .6m
+. ds #F 0
+. ds #[ \&
+. ds #] \&
+.\}
+. \" simple accents for nroff and troff
+.if n \{\
+. ds ' \&
+. ds ` \&
+. ds ^ \&
+. ds , \&
+. ds ~ ~
+. ds /
+.\}
+.if t \{\
+. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+. \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+. \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+. \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+. ds : e
+. ds 8 ss
+. ds o a
+. ds d- d\h'-1'\(ga
+. ds D- D\h'-1'\(hy
+. ds th \o'bp'
+. ds Th \o'LP'
+. ds ae ae
+. ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "PACLOCK 1"
+.TH PACLOCK 1 "2021-08-14" "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 \s-1ALPM\s0 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)