cdist-type__block(7)

Steven Armstrong

<steven-cdist--@--armstrong.cc>

Table of Contents

1. NAME
2. DESCRIPTION
3. REQUIRED PARAMETERS
4. OPTIONAL PARAMETERS
5. MESSAGES
6. EXAMPLES
7. SEE ALSO
8. COPYING

1. NAME

cdist-type__block - Manage blocks of text in files

2. DESCRIPTION

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.

3. REQUIRED PARAMETERS

text: the text to manage. If text is - (dash), take what was written to stdin as the text.

4. OPTIONAL PARAMETERS

file: the file in which to manage the text block. Defaults to object_id.
prefix: the prefix to add before the text. Defaults to #cdist:block/$object_id
suffix: the prefix to add after the text. Defaults to #/cdist:block/$object_id
state: present or absent, defaults to present

5. MESSAGES

add: block was added
update: block was updated/changed
remove: block was removed

6. EXAMPLES

# text from argument
__block /path/to/file \
   --prefix '#start' \
   --suffix '#end' \
   --text 'some\nblock of\ntext'

# text from stdin
__block some-id \
   --file /path/to/file \
   --text - << DONE
here some block
of text
DONE

7. SEE ALSO

cdist-type(7)