Documentation0.4.0

1 files changed, 82 insertions, 0 deletions

diff --git a/doc/solarctl.1.scd b/doc/solarctl.1.scd
new file mode 100644
index 0000000..91bbdc2
--- /dev/null
+++ b/doc/solarctl.1.scd
@@ -0,0 +1,82 @@
+SOLARCTL(1)
+
+# NAME
+
+solarctl - manage _solard_ instances across a network
+
+# SYNOPSIS
+
+solarctl <remote host> <subcommand> [options]
+
+
+# DESCRIPTION
+
+solarctl is a command-line API client for `solard` API servers to manage virtual
+machines over a network.
+
+# SUBCOMMANDS
+
+All subcommands except "login" will require authentication.
+
+## LOGIN
+
+Performs the first-time login process with a remote solard server, and stores it
+in $XDG_CONFIG_HOME/$REMOTE_ADDRESS/config.json.
+
+Syntax:
+	solarctl <remote host> login <random key>
+
+The random key is printed to the stdout of the remote solard server, and changes
+each time the server is restarted. The token returned will be a PASETO public
+token signed by the remote solard server.
+
+## LIST
+
+Lists all created virtual machines on the remote server.
+
+Example:
+	solarctl localhost:3000 list
+
+## PAUSE
+
+Pauses a virtual machine.
+
+Example:
+	solarctl localhost:3000 pause <uuid>
+
+The UUID of the virtual machine can be obtained from the LIST command.
+
+## STOP
+
+Sends the shutdown signal to the virtual machine. When used with *-f*, sends a
+force-shutdown signal.
+
+Example:
+	solarctl localhost:3000 stop <uuid> [-f]
+
+## REBOOT
+
+Sends the reboot signal to the virtual machine. When used with *-f*, sends a
+force-reboot signal.
+
+Example:
+	solarctl localhost:3000 reboot <uuid> [-f]
+
+## START
+
+Starts the virtual machine if it is stopped.
+
+Example:
+	solarctl localhost:3000 start <uuid>
+
+## VIEW
+
+Opens a virtual console window to the virtual machine using virt-viewer(1).
+
+Example:
+	solarctl localhost:3000 view <uuid>
+
+# SEE ALSO
+
+_virt-viewer_(1)
+