CDIST-TYPE__INSTALL_FILE(7)

✨ cdist-type__install_file ✨

okay bestie, welcome to cdist-type__install_file from the cdist manual pages (section 7, iykyk) 💖 this one is literally about managing files with the install command and it's giving main character energy fr fr

---

🎀 NAME 🎀

cdist-type__install_file — manage files with the install command 💅

---

🌸 DESCRIPTION 🌸

so this cdist type lets you create files, remove files, and set file attributes on the target. three jobs, one icon 👑

if the file already exists on the target, then here's the vibe check depending on what it is:

• regular file, and state is:
  • present — replace it with the source file if they are not equal 🔁
  • exists — do nothing, just chill 😌
• symlink — replace it with the source file
• directory — replace it with the source file

one exception bestie, and it's important: when state is pre-exists, an error is raised if the file would have been created otherwise (e.g. it is not present or not a regular file). no sneaky creation allowed 🚫

and in any case, make sure that the file attributes are as specified. periodt.

---

🦋 REQUIRED PARAMETERS 🦋

None. literally zero. nothing required, we love a low-maintenance type 🫶

---

💜 OPTIONAL PARAMETERS 💜

• state — 'present', 'absent', 'exists' or 'pre-exists', defaults to 'present' where:
  • present — the file is exactly the one from source ✨
  • absent — the file does not exist 🙈
  • exists — the file from source but only if it doesn't already exist
  • pre-exists — check that the file exists and is a regular file, but do not create or modify it 👀
• group — Group to chgrp to.
• mode — Unix permissions, suitable for chmod.
• owner — User to chown to.
• source — If supplied, copy this file from the host running cdist to the target. If not supplied, an empty file or directory will be created. If source is '-' (dash), take what was written to stdin as the file content. 🍓
• onchange — The code to run if file is modified.

---

🌈 MESSAGES 🌈

• chgrp <group> — Changed group membership
• chown <owner> — Changed owner
• chmod <mode> — Changed mode
• create — Empty file was created (no --source specified)
• remove — File exists, but state is absent, file will be removed by generated code.
• upload — File was uploaded

---

⭐ EXAMPLES ⭐

okay this is the part where it gets fun, watch 👇

# Create  /etc/cdist-configured as an empty file
__install_file /etc/cdist-configured
# The same thing
__install_file /etc/cdist-configured --state present
# Use __file from another type
__install_file /etc/issue --source "$__type/files/archlinux" --state present
# Delete existing file
__install_file /etc/cdist-configured --state absent
# Supply some more settings
__install_file /etc/shadow --source "$__type/files/shadow" \
   --owner root --group shadow --mode 0640 \
   --state present
# Provide a default file, but let the user change it
__install_file /home/frodo/.bashrc --source "/etc/skel/.bashrc" \
   --state exists \
   --owner frodo --mode 0600
# Check that the file is present, show an error when it is not
__install_file /etc/somefile --state pre-exists
# Take file content from stdin
__install_file /tmp/whatever --owner root --group root --mode 644 --source - << DONE
    Here goes the content for /tmp/whatever
DONE

---

💖 AUTHORS 💖

Nico Schottelius <nico-cdist--@--schottelius.org>

---

👑 COPYING 👑

Copyright (C) 2011-2013 Nico Schottelius. 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.

---

🌸 COPYRIGHT 🌸

ungleich GmbH 2021

---

okay bestie that's the whole page, every flag, every message, every example, all of it, no skips 💅

and that's a wrap 🎀 this was cdist version 7.0.0, dated Jul 31, 2022, and honestly? iconic. go manage some files, you've got this 🦋💖