Skip to content

Commit

Permalink
Improve spatialmsg man page
Browse files Browse the repository at this point in the history
  • Loading branch information
lthms committed Jan 21, 2024
1 parent 432a090 commit edd4bd5
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions bin/spatialmsg/spatialmsg.1.scd
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,13 @@ spatialmsg - Send messages to a running instance of Spatial Shell over the IPC s

# SYNOPSIS

spatialmsg [options...] [message]
spatialmsg [--json|--quiet] [-t <type>] [message]

# OPTIONS

*--quiet*
Sends the IPC message, but does not print the response from Spatial
Shell.

*--json*
Prints the response from Spatial Shell as received, that is in JSON.
*--type, -t <type>*
Expand Down Expand Up @@ -45,10 +44,16 @@ message.
Success

1
Invalid command line arguments
Invalid but correctly parsed command line arguments

2
Spatial Shell returned an error when
Spatial Shell returned an error

124
Command line parsing errors

125
Internal errors (bugs)

# AUTHOR

Expand Down

0 comments on commit edd4bd5

Please sign in to comment.