mirror of
https://github.com/jwetzell/osc-go.git
synced 2026-09-10 07:49:28 +00:00
document usage for OSC utilities
This commit is contained in:
@@ -4,6 +4,52 @@ A mostly complete OSC implementation and collection of command line OSC utilitie
|
|||||||
|
|
||||||
## Utilities
|
## Utilities
|
||||||
|
|
||||||
### `sendosc`
|
### sendosc
|
||||||
### `makeosc`
|
```
|
||||||
### `receiveosc`
|
NAME:
|
||||||
|
sendosc - send OSC messages via UDP or TCP
|
||||||
|
|
||||||
|
USAGE:
|
||||||
|
sendosc [global options]
|
||||||
|
|
||||||
|
GLOBAL OPTIONS:
|
||||||
|
--host string host to send OSC message to
|
||||||
|
--port int port to send OSC message to
|
||||||
|
--protocol string protocol to use to send (tcp or udp) (default: "udp")
|
||||||
|
--address string OSC address
|
||||||
|
--arg string [ --arg string ] OSC args
|
||||||
|
--type string [ --type string ] OSC types
|
||||||
|
--slip whether to slip encode the OSC Message bytes
|
||||||
|
--help, -h show help
|
||||||
|
```
|
||||||
|
### makeosc
|
||||||
|
```
|
||||||
|
NAME:
|
||||||
|
makeosc - make osc bytes
|
||||||
|
|
||||||
|
USAGE:
|
||||||
|
makeosc [global options]
|
||||||
|
|
||||||
|
GLOBAL OPTIONS:
|
||||||
|
--address string OSC address
|
||||||
|
--arg string [ --arg string ] OSC args
|
||||||
|
--type string [ --type string ] OSC types
|
||||||
|
--slip whether to slip encode the OSC Message bytes
|
||||||
|
--help, -h show help
|
||||||
|
```
|
||||||
|
### receiveosc
|
||||||
|
```
|
||||||
|
NAME:
|
||||||
|
receiveosc - receive OSC messages via UDP or TCP
|
||||||
|
|
||||||
|
USAGE:
|
||||||
|
receiveosc [global options]
|
||||||
|
|
||||||
|
GLOBAL OPTIONS:
|
||||||
|
--ip string ip to receive OSC messages on (default: "0.0.0.0")
|
||||||
|
--port int port to receive OSC messages on (default: 8888)
|
||||||
|
--protocol string protocol to use to receive (tcp or udp) (default: "udp")
|
||||||
|
--format string format for messages to be output in ('json') (default: "json")
|
||||||
|
--slip whether to slip encode the OSC Message bytes
|
||||||
|
--help, -h show help
|
||||||
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user