.\" Man page generated from reStructuredText.
.
.TH "CDIST-TYPE__BLOCK" "7" "Jun 23, 2019" "5.1.2" "cdist"
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH NAME
.sp
cdist\-type__block \- Manage blocks of text in files
.SH DESCRIPTION
.sp
Manage a block of text in an existing file.
The block is identified using the prefix and suffix parameters.
Everything between prefix and suffix is considered to be a managed block
of text.
.SH REQUIRED PARAMETERS
.INDENT 0.0
.TP
.B text
the text to manage.
If text is \(aq\-\(aq (dash), take what was written to stdin as the text.
.UNINDENT
.SH OPTIONAL PARAMETERS
.INDENT 0.0
.TP
.B file
the file in which to manage the text block.
Defaults to object_id.
.TP
.B prefix
the prefix to add before the text.
Defaults to #cdist:__block/$__object_id
.TP
.B suffix
the suffix to add after the text.
Defaults to #/cdist:__block/$__object_id
.TP
.B state
\(aqpresent\(aq or \(aqabsent\(aq, defaults to \(aqpresent\(aq
.UNINDENT
.SH MESSAGES
.INDENT 0.0
.TP
.B add
block was added
.TP
.B update
block was updated/changed
.TP
.B remove
block was removed
.UNINDENT
.SH EXAMPLES
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# text from argument
__block /path/to/file \e
   \-\-prefix \(aq#start\(aq \e
   \-\-suffix \(aq#end\(aq \e
   \-\-text \(aqsome\enblock of\entext\(aq

# text from stdin
__block some\-id \e
   \-\-file /path/to/file \e
   \-\-text \- << DONE
here some block
of text
DONE
.ft P
.fi
.UNINDENT
.UNINDENT
.SH AUTHORS
.sp
Steven Armstrong <\fI\%steven\-cdist\-\-@\-\-armstrong.cc\fP>
.SH COPYING
.sp
Copyright (C) 2013 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
.SH COPYRIGHT
ungleich GmbH 2019
.\" Generated by docutils manpage writer.
.