CDIST-TYPE__BLOCK(7)

📦
version 7.0.0 · 8 versions
, in fedora 43, fedora 44

💖 cdist-type__block — the manual, but make it make sense 💖

okay bestie, so this is cdist-type__block, section 7 of the cdist manual, and it's genuinely one of the most useful lil types out there. let me put you on. 🫶

✨ NAME ✨

cdist-type__block — manage blocks of text in files. that's it, that's the whole job, and she does it flawlessly. 💅

🌸 DESCRIPTION 🌸

So here's the tea: this type manages a block of text inside an existing file. Not a whole file, just a lil section of one. 🎀

How does it know which section? It finds it using the prefix and suffix parameters. Literally everything sitting between prefix and suffix is considered a managed block of text. Like, that's the block. that's the girl. 👑

🔥 REQUIRED PARAMETERS 🔥

  • text — the text to manage. and listen, if text is '-' (a dash, yes the little line), then it takes whatever was written to stdin as the text. stdin girlies rise up 🫶

✨ OPTIONAL PARAMETERS ✨

  • file — the file in which to manage the text block. defaults to object_id. so if you don't say where, it just uses the object id, no cap.
  • 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'. iconic little toggle, she decides if the block stays or goes 💅

💌 MESSAGES 💌

  • add — block was added ✨
  • update — block was updated/changed 🌈
  • remove — block was removed 💀

🦋 EXAMPLES 🦋

bestie these are copy-paste ready, run them exactly like this:

# 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

see that first one? text straight from the argument, no stdin required, main character energy. and the second one? --text - and then boom, heredoc, block of text delivered fresh from stdin. obsessed. 😭✨

👑 AUTHORS 👑

Steven Armstrong <steven-cdist--@--armstrong.cc> — the icon, the legend, the blueprint. we stan. 🫶

📜 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.

like yes, go forth, remix, redistribute, it's giving open source royalty 💖

ungleich GmbH 2021

fr fr, if you're gonna manage text blocks in files, this is the way. no notes. periodt. 💅

and that's the whole page bestie — this was cdist-type__block from version 7.0.0, dated Jul 31, 2022. go forth and block responsibly 🎀💜

📦 where this page comes from