Module: Qcmd::Commands::Help

Defined in:
lib/qcmd/commands.rb

Class Method Summary collapse

Class Method Details



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
# File 'lib/qcmd/commands.rb', line 146

def print_all_commands
  Qcmd.print %[
#{Qcmd.centered_text(' Available Commands ', '-')}

exit

  close qcmd


connect MACHINE_NAME

  connect to the machine with name MACHINE_NAME


disconnect

  disconnect from the current machine and workspace


use WORKSPACE_NAME [PASSCODE]

  connect to the workspace with name WORKSPACE_NAME using passcode PASSCODE. A
  passcode is only required if the workspace has one enabled.


workspaces

  show a list of the available workspaces for the currently connected machine.


workspace COMMAND [VALUE]

  pass the given COMMAND to the connected workspace. The following commands will
  act on a workspace but will not return a value:

    #{Qcmd.wrapped_text(Qcmd::Commands::WORKSPACE_NO_RESPONSE.sort.join(', '), :indent => '    ').join("\n")}

  And these commands will not act on a workspace, but will return a value
  (usually a list of cues):

    #{Qcmd.wrapped_text((Qcmd::Commands::WORKSPACE_RESPONSE - ['connect']).sort.join(', '), :indent => '    ').join("\n")}

  * Pro Tip: once you are connected to a workspace, you can just use COMMAND
  and leave off "workspace" to quickly send the given COMMAND to the connected
  workspace.


cue NUMBER COMMAND [VALUE [ANOTHER_VALUE ...]]

  send a command to the cue with the given NUMBER.

  NUMBER can be a string or a number, depending on the command.

  COMMAND can be one of:

    #{Qcmd.wrapped_text(Qcmd::Commands::ALL_CUE_COMMANDS.sort.join(', '), :indent => '    ').join("\n")}

  Of those commands, only some accept a VALUE. The following commands, if given
  a value, will update the cue:

    #{Qcmd.wrapped_text(Qcmd::Commands::CUE_ARG.sort.join(', '), :indent => '    ').join("\n")}

  Some cues are Read-Only and will return information about a cue:

    #{Qcmd.wrapped_text(Qcmd::Commands::CUE_RESPONSE.sort.join(', '), :indent => '    ').join("\n")}

  Finally, some commands act on a cue, but don't take a VALUE and don't
  respond:

    #{Qcmd.wrapped_text(Qcmd::Commands::CUE_NO_RESPONSE.sort.join(', '), :indent => '    ').join("\n")}

]
end