Mercurial > imgup

annotate imgupd-clean.8.in @ 35:3e01d0147294

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