Mercurial > paster

annotate pasterd-clean.8.in @ 59:fba88439ec0a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: update copyright years
author David Demelier <markand@malikania.fr>
date Mon, 12 Apr 2021 20:31:18 +0200
parents 511e2e865e15
children ecb0b90d94d8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 .\"
59
fba88439ec0a misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 33
diff changeset
2 .\" Copyright (c) 2020-2021 David Demelier <markand@malikania.fr>
17
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 .\"
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 .\" Permission to use, copy, modify, and/or distribute this software for any
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 .\" purpose with or without fee is hereby granted, provided that the above
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 .\" copyright notice and this permission notice appear in all copies.
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 .\"
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 .\"
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 .Dd 06 February, 2020
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 .Dt PASTERD-CLEAN 8
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 .Os
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 .\" NAME
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 .Sh NAME
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 .Nm pasterd-clean
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 .Nd simple paste service cleaner
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 .\" SYNOPSIS
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 .Sh SYNOPSIS
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 .Nm
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 .Op Fl d Ar database-path
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 .\" DESCRIPTION
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 .Sh DESCRIPTION
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 This utility should be used at periodic intervals to clean up the SQLite
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 database. It will remove deprecated pastes.
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 .Pp
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 Like
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 .Xr pasterd 8
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 it can use environment variables or option to specify the database.
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 .Pp
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 Available options:
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 .Bl -tag -width Ds
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 .It Fl d Ar database-path
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 Specify an alternate path for the database.
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 .El
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 .\" USAGE
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 .Sh USAGE
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 This command should be placed in a cron job (or equivalent) at periodic
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 intervals. Since the minimal lifetime for a paste is one hour a periodic job
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 every hour seems appropriate.
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 .Pp
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 Note: make sure to run the cron job in the same user as the pasterd service,
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 otherwise you may change file permissions.
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 .Pp
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 Example of cron job:
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 .Bd -literal -offset Ds
31
5f95e28ba3bb pasterd-clean: forgot to install manual page
David Demelier <markand@malikania.fr>
parents: 17
diff changeset
52 0 * * * * www pasterd-clean -d /var/paster/paster.db
17
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 .Ed
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 .\" ENVIRONMENT
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 .Sh ENVIRONMENT
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 The following environment variables are detected:
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 .Bl -tag -width Ds
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 .It Va PASTERD_DATABASE_PATH No (string)
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 Path to the SQLite database.
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 .El
33
511e2e865e15 doc: advertise myself in manual pages
David Demelier <markand@malikania.fr>
parents: 31
diff changeset
61 .\" AUTHORS
511e2e865e15 doc: advertise myself in manual pages
David Demelier <markand@malikania.fr>
parents: 31
diff changeset
62 .Sh AUTHORS
511e2e865e15 doc: advertise myself in manual pages
David Demelier <markand@malikania.fr>
parents: 31
diff changeset
63 .Nm
511e2e865e15 doc: advertise myself in manual pages
David Demelier <markand@malikania.fr>
parents: 31
diff changeset
64 was written by David Demelier <markand@malikania.fr>
17
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 .\" SEE ALSO
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 .Sh SEE ALSO
09d2f54562ec pasterd-clean: initial import, closes #2473
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 .Xr pasterd 8