carta
cdist-type__block(7)

cdist-type__block7

Manage blocks of text in files

Overview

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.

Required parameters

text

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

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 suffix to add after the text. Defaults to #/cdist:__block/$__object_id

state

'present' or 'absent', defaults to 'present'

Messages

add

block was added

update

block was updated/changed

remove

block was removed

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

Copying

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.

History

  • Debian 13 (Trixie): the text shown here
  • Debian 12 (Bookworm)
  • Debian 11 (Bullseye)
  • Debian 10 (Buster)
  • Debian 9 (Stretch)

Authors

Steven Armstrong <[email protected]>

From cdist 7.0.0-5 in Debian 13 (Trixie). Parsed by carta from the page's man source.