Create README.md

This commit is contained in:
bilbo-b 2021-02-02 22:37:02 +01:00 committed by GitHub
parent e1fa9e7de5
commit f3dbfc44f4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

18
README.md Normal file
View File

@ -0,0 +1,18 @@
# rock
a shell script to remote control some aspects of a roonlabs ROCK installation
rock <cmd>
possible <cmd> are:
poweroff: shuts down gracefully and powers off at $ROCKIP
wake: sends "magic packet" to ROCK over network to power on
status: gives back some JSON-formatted status output of ROCK at $ROCKIP
has_cdrom: outputs "no_cd_rom" if none connected or other
eject: ejects disk in a connected CDROM (if one is connected)
reboot: reboots your ROCK
restart: restarts ROON software
stop: stops ROON software
wake: sends "magic packet" to ROCK over network to power on
requirements:
poweroff, status, has_cdrom, eject, reboot, restart, stop need "curl"
wake needs "etherwake" and the proper mac-address in /etc/ethers for "rock"
status, has_cdrom and eject need "jq" installed