elias/ark-ac-server-tools
1
0
Fork 0
mirror of https://github.com/eliasstepanik/ark-ac-server-tools.git synced 2026-01-27 08:48:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update usage

Browse Source
This commit is contained in:
Ben Peddell 2017-07-01 12:08:03 +10:00
parent 96aec9d715
commit 3975d3b6c4
1 changed files with 94 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

137
tools/arkmanager
View File

@ -2933,49 +2933,100 @@ addArkOpt() {
showUsage() { showUsage() {
echo -e "Usage: arkmanager [Commands]\n" echo -e "Usage: arkmanager [Commands]\n"
echo "Commands can be followed by one or more @instance arguments" cat <<-EOE
echo "The special '@all' instance selects all instances" Commands can be followed by one or more @instance arguments
echo "Commands may also be followed by zero or more --options" The special '@all' instance selects all instances
echo Commands may also be followed by zero or more --options
echo "Commands that take no instances:"
echo "Command Description" Commands that take no instances:
echo "upgrade-tools Check for a new ARK Server Tools version and upgrades it if needed" Command Description
echo "uninstall-tools Uninstall the ARK Server Tools" upgrade-tools Check for a new ARK Server Tools version and upgrades it if needed
echo "useconfig <name> Sets the default instance for the commands that follow" uninstall-tools Uninstall the ARK Server Tools
echo "list-instances Lists all available instances" useconfig <name> Sets the default instance for the commands that follow
echo "--help Show this help" remove-mods <modid> Remove one or more mods from the steamcmd workshop directory
echo "--version Show the version info of ARK Server Tools" list-instances Lists all available instances
echo --help Show this help
echo "Commands that take one or more instances:" --version Show the version info of ARK Server Tools
echo "Command Description"
echo "backup Saves a backup of your server inside the backup directory" Commands that take one or more instances:
echo "broadcast <msg> Sends a message to all users connected to server" Command Description
echo "saveworld Saves the game world to disk" backup Saves a backup of your server inside the backup directory
echo "rconcmd <cmd> Execute RCON command on server" broadcast <msg> Sends a message to all users connected to server
echo "checkupdate Check for a new ARK server version" saveworld Saves the game world to disk
echo "install Install the ARK server files from steamcmd" rconcmd <cmd> Execute RCON command on server
echo "installmod <modid> Installs a mod from the Steam workshop" checkupdate Check for a new ARK server version
echo "uninstallmod <modid> Removes the mod from the Mods directory" checkmodupdate Checks for any mods needing updates
echo "reinstallmod <modid> Removes and re-installs a mod in the Mods directory" install Install the ARK server files from steamcmd
echo "install-cronjob <cmd> Adds a cron job using the specified command" installmod <modid> Installs a mod from the Steam workshop
echo "remove-cronjob <cmd> Removes a cron job that used the specified command" uninstallmod <modid> Removes the mod from the Mods directory
echo "restart Stops the server and then starts it" reinstallmod <modid> Removes and re-installs a mod in the Mods directory
echo "run Runs the server without daemonizing" enablemod <modid> Enables a mod in the config
echo "start Starts the server" disablemod <modid> Disables a mod in the config
echo "stop Stops the server" installmods Installs all enabled mods
echo "status Returns the status of the current ARK server instance" uninstallmods Removes all installed mods from the Mods directory
echo "update Check for a new ARK server version, if needed, stops the server, updates it, and starts it again" install-cronjob <cmd> Adds a cron job using the specified command
echo remove-cronjob <cmd> Removes a cron job that used the specified command
echo "Update command takes the below options:" restart Stops the server and then starts it
echo " --force Apply update without checking the current version" run Runs the server without daemonizing
echo " --safe Wait for server to perform world save and update." start Starts the server
echo " --warn Warn players before updating server" stop Stops the server
echo " --validate Validates all ARK server files" cancelshutdown Aborts a running stop --warn or update --warn
echo " --saveworld Saves world before update" status Returns the status of the current ARK server instance
echo " --update-mods Updates installed and requested mods" printconfig Displays which settings are sourced from which config file
echo " --backup Takes a backup of the save files before updating" getpid Gets the running server PID
echo " --downloadonly Download the mod and/or server update without applying it" update Check for a new ARK server version, if needed, stops the server, updates it, and starts it again
echo " Requires arkStagingDir be set to a staging directory on the same filesystem as the server"
Commands which invoke steamcmd take the following options:
--verbose Show steamcmd output
--spinner Use a spinner for progress (default)
--dots Use dots for progress
Update command takes the following options:
--force Apply update without checking the current version
--safe Wait for server to perform world save and update (deprecated, use --saveworld)
--warn Warn players before updating server
--ifempty Apply the update only if no players are connected
--validate Validates all ARK server files
--saveworld Saves world before update
--update-mods Updates installed and requested mods
--backup Takes a backup of the save files before updating
--downloadonly Download the mod and/or server update without applying it
Requires arkStagingDir be set to a staging directory on the same filesystem as the server
--no-download Applies an already downloaded update from the staging directory
--systemd Use the SystemD arkmanager@instance.service to restart the server
--service Use the sysv-init arkmanager service to restart the server
--upstart Use the Upstart arkmanager service to restart the server
--no-autostart Don't start the server after updating
--warnreason=... Specify an update reason other than the default
Stop and restart commands take the following options:
--saveworld Saves world before shutdown
--warn Warn players before stopping server
--warnreason=... Specify a shutdown reason other than the default
Start and restart commands take the following options:
--noautoupdate Disable any automatic update that may be enabled in the config
--alwaysrestart Always restart server on crash, even if it did not finish starting
--no-background Run the server without going into the background
--arkopt,opt=val Add an ARK option:
-opt=val Equivalent to adding arkopt_opt=val to config for this run
-opt Equivalent to adding arkflag_opt=true to config for this run
opt=val Equivalent to adding ark_opt=val to config for this run
installmod command takes the following options:
--validate Forcibly re-download the mod from the steam workshop
install-cronjob command takes the following options:
--daily Run once a day (default)
--hourly Run once an hour
--hour=<hour> Hour of the day to run command
--minute=<min> Minute of the hour to run command
--enable-output Don't redirect the output of the command
--arg=option Option to pass to command
list-instances command takes the following options:
--brief Only list instance names
EOE
} }
#--------------------- #---------------------