rmc.1

.TH rmc 1 "25 Jan 2025" "version 1.0"

.SH NAME
rmc - a remote command runner

.SH SYNOPSIS
rmc [\fBOPTIONS\fR...] [\fBCOMMAND\fR]

.SH DESCRIPTION
rmc is a "remote command runner". You can start the rmc server in one terminal
with \fBrmc [-c|-r|-v|-q|-d]\fR, and send commands to it with \fBrmc COMMAND\fR. The server
will run the command in the same environment and working directory as the client
that sent it. The server may be controlled further with the options \fB--cancel\fR
and \fB--kill\fR. Multiple servers can be running at once using the \fB--name\fR option.

.SH OPTIONS
.TP
.B -v,\ --verbose
Print working directory and command string before each run.
.TP
.B -c,\ --clear
Clear the terminal in between each run.
.TP
.B -h,\ --help
Show this help message.
.TP
.B -r,\ --reset
Interrupt the running command if a new one is received.
.TP
.B -q,\ --quiet
Don't print exit status. Cancels out \fB--verbose\fR.
.TP
.B -p,\ --pid
Get process ID of server.
.TP
.B -C,\ --cancel
Cancel running command remotely (shorthand for \fBkill -SIGUSR1 $(rmc --pid)\fR).
.TP
.B -k,\ --kill
Kill the server (shorthand for \fBkill -SIGTERM $(rmc --pid)\fR).
.TP
.B -l,\ --list
List active servers.
.TP
.B -d,\ --daemon
Start in daemon mode.
.TP
.B -N,\ --notify
Send a desktop notification when command starts/finishes (requires rmc to be built with WITH_LIBNOTIFY=1).
.TP
.B -n,\ --name=\fINAME\fR
Select/start server with name \fINAME\fR. The default name is 'default'.

.SH EXAMPLES
.TP
Start the default server.
.B rmc
.TP
Send a command to the default server.
.B rmc echo hello
.TP
Start a server with name 'myserver', and clear the terminal between each run.
.B rmc -cn myserver
.TP
Kill server with name 'myserver'.
.B rmc -kn myserver
.TP
Interrupt a command running on the default server remotely.
.B rmc -C
.TP