.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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 "PETRIFIED 1"
.TH PETRIFIED 1 "2014-11-24" "petrified 1.0.2" "Petrified Manual"
.\" 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"
petrified \- bash client to update dynamic DNS at freedns.afraid.org
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
Usage: \fBpetrified\fR [ \fB\-c\fR \fIconfig\fR ]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBpetrified\fR is a bash client to update dynamic \s-1DNS\s0 hosted at
<https://freedns.afraid.org>; the software goals are for simplicity,
flexibility and configurability while using the minimal system tools
installed with most distributions.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-c\fR \fIconfig\fR" 4
.IX Item "-c config"
Specify an exact config file to use, ignoring global and per-user configs.
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
See \fIpetrified.conf\fR for all available options and their usage.
.PP
Copy the default configuration file to \fI/etc/petrified.conf\fR for global
use, \fI~/.petrifiedrc\fR for user-level use, or another location as desired.
At a minimum the \f(CW\*(C`DDNS_KEY\*(C'\fR variable must be configured for basic usage;
all other variables are preconfigured for system level (root) usage.
.PP
If implementing at the user level, be sure and set the various file options
to locations that are writable by the user; the default config is fully
documented and should make sense.
.PP
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 "DEPENDENCIES"
.IX Header "DEPENDENCIES"
.Vb 7
\& Utilities                          | Package
\& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-
\& logger, kill                       | util\-linux
\& printf, touch, date, stat, cat, rm | coreutils
\& bash                               | bash
\& ip                                 | iproute2
\& curl                               | curl
.Ve
.SH "FILES"
.IX Header "FILES"
.IP "\fI/etc/petrified.conf\fR" 4
.IX Item "/etc/petrified.conf"
Global configuration file
.IP "\fI~/.petrifiedrc\fR" 4
.IX Item "~/.petrifiedrc"
Per-user configuration file
.IP "\fI/var/cache/petrified/lastip.dat\fR" 4
.IX Item "/var/cache/petrified/lastip.dat"
\&\s-1IP\s0 cache (if feature enabled \- default: yes)
.IP "\fI/run/petrified.pid\fR" 4
.IX Item "/run/petrified.pid"
\&\s-1PID\s0 file (if feature enabled \- default: no)
.IP "\fI/var/log/petrified.log\fR" 4
.IX Item "/var/log/petrified.log"
\&\s-1LOG\s0 file (if feature enabled \- default: no)
.SH "AUTHOR"
.IX Header "AUTHOR"
Copyright (c) 2014 Troy Engel
.PP
GPLv3 \- see \s-1LICENSE\s0 for details
.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 \*(L"http://freedns.afraid.org\*(R" in Free \s-1DNS\s0 project.