diff --git a/confluent_client/doc/man/confetty.ronn b/confluent_client/doc/man/confetty.ronn new file mode 100644 index 00000000..b7c4758b --- /dev/null +++ b/confluent_client/doc/man/confetty.ronn @@ -0,0 +1,37 @@ +confetty(1) --- Interactive confluent client +================================================= + +## SYNOPSIS + +`confetty` + +## DESCRIPTION + +**confetty** launches an interactive CLI session to the +confluent service. It provides a filesystem-like +view of the confluent interface. It is intended to +be mostly an aid for developing client software, with +day to day administration generally being easier with +the various function specific commands. + +## COMMANDS + +The CLI may be navigated by shell commands and some other +commands. + +* `cd`: + Change the location within the tree +* `ls`: + List the elements within the current directory/tree +* `show` **ELEMENT**, `cat` **ELEMENT**: + Display the result of reading a specific element (by full or relative path) +* `unset` **ELEMENT** **ATTRIBUTE** + For an element with attributes, request to clear the value of the attribue +* `set` **ELEMENT** **ATTRIBUTE**=**VALUE** + Set the specified attribute to the given value +* `start` **ELEMENT** + Start a console session indicated by **ELEMENT** (e.g. /nodes/n1/console/session) +* `rm` **ELEMENT** + Request removal of an element. (e.g. rm events/hardware/log clears log from a node) + + diff --git a/confluent_client/doc/man/nodeconsole.ronn b/confluent_client/doc/man/nodeconsole.ronn new file mode 100644 index 00000000..c7e3eb4d --- /dev/null +++ b/confluent_client/doc/man/nodeconsole.ronn @@ -0,0 +1,30 @@ +nodeconsole(1) -- Open a console to a confluent node +===================================================== + +## SYNOPSIS +`nodeconsole` `node` + +## DESCRIPTION + +**nodeconsole** opens an interactive console session to a given node. This is the +text or serial console of a system. Exiting is done by hitting `Ctrl-e`, then `c`, + then `.`. Note that console output by default is additionally logged to +`/var/log/confluent/consoles/`**NODENAME**. + +## ESCAPE SEQUENCE COMMANDS + +While connected to a console, a number of commands may be performed through escape +sequences. To begin an command escape sequence, hit `Ctrl-e`, then `c`. The next +keystroke will be interpreted as a command. The following commands are available. + +* `.`: + Exit the session and return to the command prompt +* `b`: + Send a break to the remote console when possible (some console plugins may not support this) +* `o`: + Request confluent to disconnect and reconnect to console. For example if there is suspicion + that the console has gone inoperable, but would work if reconnected. +* `?`: + Get a list of supported commands +* ``: + Abandon entering an escape sequence command