Command Line

Documentation / CyPower

• Overview of CyPower
  • What It Does
  • What It Is Not
• Using CyPower
  • Why The Rows Grey Out
  • What A Click Does
  • Checking The Grant
  • End Session Versus Power Rows
• Command Line
  • Actions
  • Safe Probes
  • Rule And Host Facts
• Copyright

Command Line

cypower performs exactly two actions: reboot and halt. Everything else is inspection for installers and admins. The binary is not on PATH until cyanotype.inst has installed a power grant; the Toolchest greys Restart / Shut Down while it is absent.

cypower reboot
cypower halt

Actions

• cypower reboot -- restart this machine
• cypower halt -- shut this machine down (power off where the OS can)

Nothing else is or will be granted. The doas/sudo rule names these two command lines only.

Safe Probes

• --dry-run ACTION -- print the exact command; run nothing
• --check ACTION -- exit 0 if ACTION is permitted right now (no reboot)

cypower --dry-run reboot
cypower --check halt

Rule And Host Facts

For cyanotype.inst and hand install:

• --rule -- print the doas.conf or sudoers text for this host
• --rule-path -- print the file that text belongs in
• --grants -- print the two permitted commands, one per line
• --facts -- key=value host facts (os, tool, paths, append vs drop-in, whether SGI sysadm tasks exist, account)

Overrides (for --rule / --selftest, not for everyday reboot):

• --os=NAME -- netbsd, openbsd, freebsd, linux, or irix
• --tool=NAME -- doas or sudo
• --user=NAME -- account the rule grants to (default: you)

--os skips the this-host probe for shutdown(8), because this filesystem cannot tell you where another OS keeps it.

Selftest And Help

• --selftest -- prove the generated rule and the command cannot drift
• -h, --help / -V, --version

Examples

cypower --facts
cypower --rule
cypower --rule-path
cypower --grants
cypower --os=netbsd --tool=doas --rule

See Also

• Using CyPower
• Overview of CyPower