tengel/petrified
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update man page, bump version

Browse source
This commit is contained in:
tengel 2024-03-20 09:32:36 -05:00
parent 29eb2609b6
commit 3955f39444
2 changed files with 64 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

2
petrified
View file

@ -2,7 +2,7 @@
#
## petrified - bash client to update dynamic DNS at freedns.afraid.org
## Copyright (c) 2015 Troy Engel
## Version: 1.0.5
## Version: 1.0.6
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by

69
petrified.1
View file

@ -1,4 +1,4 @@
.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" Standard preamble:
.\" ========================================================================
@ -133,7 +133,7 @@
.\" ========================================================================
.\"
.IX Title "PETRIFIED 1"
.TH PETRIFIED 1 "2015-03-08" "petrified 1.0.5" "Petrified Manual"
.TH PETRIFIED 1 "2016-01-24" "petrified 1.0.6" "Petrified Manual"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@ -170,6 +170,62 @@ documented and should make sense.
To use a custom configuration file, the \f(CW\*(C`\-c config\*(C'\fR parameter is supported;
note that using this option will not read the global or local configuration
files and only use the variables from this custom file.
.SH "SYSTEMD"
.IX Header "SYSTEMD"
The provided systemd unit files are designed to use the native systemd timer
functionality in place of a cron daemon. The timer can be activated as the
system user which will use specifically the global \fI/etc/petrified.conf\fR
configuration, or as any given user which will use the \fI~/.petrifiedrc\fR
configuration.
.PP
.Vb 2
\& system: systemctl \-\-now enable petrified.timer
\& systemctl list\-timers petrified.timer
\&
\& user: systemctl \-\-user \-\-now enable petrified.timer
\& systemctl \-\-user list\-timers petrified.timer
.Ve
.PP
A target of \f(CW\*(C`petrified.target\*(C'\fR is pre-configured if multuple interfaces are
to be configured; per standard systemd methodology the existing service unit
is first customized either at the system or user level, then all custom units
and the timer are started/enabled.
.PP
For example at the system level if two interfaces are to be used, it might
look like:
.PP
.Vb 5
\& /etc/systemd/system/petrified\-iface1.service
\& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\& .include /usr/lib/systemd/system/petrified.service
\& [Service]
\& ExecStart=/usr/bin/petrified \-c /etc/petrified\-iface1.conf
\&
\& /etc/systemd/system/petrified\-iface2.service
\& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\& .include /usr/lib/systemd/system/petrified.service
\& [Service]
\& ExecStart=/usr/bin/petrified \-c /etc/petrified\-iface2.conf
.Ve
.PP
Then both customized service units are enabled, as well as the timer unit:
.PP
.Vb 3
\& systemctl \-\-now enable petrified\-iface1.service
\& systemctl \-\-now enable petrified\-iface2.service
\& systemctl \-\-now enable petrified.timer
.Ve
.PP
The per user configuration looks the same and is usually configured in the
\&\fI~/.config/systemd/user/\fR space in the home directory. The provided units
for the service contain the connection to the target pre-configured.
.IP "\fBSee also:\fR" 4
.IX Item "See also:"
<http://www.freedesktop.org/software/systemd/man/systemd.unit.html>
.Sp
<http://www.freedesktop.org/software/systemd/man/systemd.timer.html>
.Sp
<http://www.freedesktop.org/software/systemd/man/systemd.target.html>
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
.Vb 7
@ -203,9 +259,10 @@ Per-user configuration file
Copyright (c) 2015 Troy Engel
.PP
GPLv3 \- see \s-1LICENSE\s0 for details
.SH "SUPPORT"
.IX Header "SUPPORT"
If you like this software, please consider upgrading to a Premium account
to help support the Free \s-1DNS\s0 <http://freedns.afraid.org> project. All
questions and issues should be asked/reported via the Github project:
.PP
<https://github.com/troyengel/petrified>
.SS "\s-1SUPPORT\s0"
.IX Subsection "SUPPORT"
If you like this software, please consider upgrading to a Premium account
to help support the Free \s-1DNS\s0 <http://freedns.afraid.org> project.