|
1 # pcons.cif |
|
2 # |
|
3 # Copyright (c) 2010 Accenture. All rights reserved. |
|
4 # This component and the accompanying materials are made available |
|
5 # under the terms of the "Eclipse Public License v1.0" |
|
6 # which accompanies this distribution, and is available |
|
7 # at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 # |
|
9 # Initial Contributors: |
|
10 # Accenture - Initial contribution |
|
11 # |
|
12 |
|
13 ==name pcons |
|
14 |
|
15 ==short-description |
|
16 |
|
17 Manipulates persistent console objects. |
|
18 |
|
19 ==see-also |
|
20 |
|
21 Commands: |
|
22 |
|
23 L<console|console>, L<ioinfo|ioinfo> |
|
24 |
|
25 Tool-kit documentation: |
|
26 |
|
27 F<Persistent Consoles>, F<Consoles> |
|
28 |
|
29 ==argument enum operation optional |
|
30 |
|
31 The operation to perform. Defaults to C<list>. |
|
32 |
|
33 ==enum-value list |
|
34 |
|
35 List the currently running persistent consoles. |
|
36 |
|
37 ==enum-value new |
|
38 |
|
39 Create a new persistent console. |
|
40 |
|
41 ==enum-value connect |
|
42 |
|
43 Attach the current console to an existing persistent console. |
|
44 |
|
45 ==enum-value start |
|
46 |
|
47 Effectively the same as a C<new> followed by a C<connect>. However, if a persistent console of the specified name already exists, no error is reported. Note, in this circumstance the C<command> argument is ignored. |
|
48 |
|
49 ==enum-value disconnect |
|
50 |
|
51 Detach the current console from the peristent console that is connected to. |
|
52 |
|
53 ==argument string name optional |
|
54 |
|
55 The name of the persistent console to use. For C<list>, this is used as a match string and defaults to C<*>. For C<disconnect>, defaults to the current persistent console if not given. Must be provided for C<connect>. |
|
56 |
|
57 ==argument string command optional |
|
58 |
|
59 The executable to be launched within a new persistent console. Only applicable for C<new> and C<start> operations. Defaults to C<fshell>. |
|
60 |
|
61 ==argument string command_args optional last |
|
62 |
|
63 The arguments for the executable to be launched within a new persistent console. |
|
64 |
|
65 ==option bool v verbose |
|
66 |
|
67 Display verbose information. |
|
68 |
|
69 |
|
70 ==copyright |
|
71 |
|
72 Copyright (c) 2006-2010 Accenture. All rights reserved. |
|
73 |