xref: /onnv-gate/usr/src/cmd/svc/svccfg/svccfg_help.c (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
28*0Sstevel@tonic-gate 
29*0Sstevel@tonic-gate #include "svccfg.h"
30*0Sstevel@tonic-gate #include "svccfg_grammar.h"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate struct help_message help_messages[] = {
33*0Sstevel@tonic-gate 	{ SCC_VALIDATE, "validate file\n\n"
34*0Sstevel@tonic-gate 		"Process a manifest file without changing the repository."
35*0Sstevel@tonic-gate 	},
36*0Sstevel@tonic-gate 	{ SCC_IMPORT, "import file\n\nImport a manifest into the repository." },
37*0Sstevel@tonic-gate 	{ SCC_EXPORT, "export {service | pattern} [> file]\n\n"
38*0Sstevel@tonic-gate "Print a manifest for service to file, or standard output if not specified."
39*0Sstevel@tonic-gate 	},
40*0Sstevel@tonic-gate 	{ SCC_ARCHIVE, "archive [> file]\n\n"
41*0Sstevel@tonic-gate "Print an archive to file, or standard output if not specified."
42*0Sstevel@tonic-gate 	},
43*0Sstevel@tonic-gate 	{ SCC_APPLY, "apply file\n\nApply a profile." },
44*0Sstevel@tonic-gate 	{ SCC_EXTRACT, "extract [> file]\n\n"
45*0Sstevel@tonic-gate "Print a profile to file, or standard output if not specified." },
46*0Sstevel@tonic-gate 	{ SCC_REPOSITORY, "repository file\n\nSet the repository to modify." },
47*0Sstevel@tonic-gate 	{ SCC_INVENTORY, "inventory file\n\n"
48*0Sstevel@tonic-gate 		"Print the services and instances contained in a manifest."
49*0Sstevel@tonic-gate 	},
50*0Sstevel@tonic-gate 	{ SCC_SET, "set [-vV]\n\n"
51*0Sstevel@tonic-gate "Without arguments, display current options.  Otherwise set the given options."
52*0Sstevel@tonic-gate 	},
53*0Sstevel@tonic-gate 	{ SCC_END, "end\n\nStop processing and exit." },
54*0Sstevel@tonic-gate 	{ SCC_HELP, "help [command]\n\nDisplay help." },
55*0Sstevel@tonic-gate 	{ SCC_LIST, "list [glob_pattern]\n\n"
56*0Sstevel@tonic-gate 		"List children of the currently selected entity."
57*0Sstevel@tonic-gate 	},
58*0Sstevel@tonic-gate 	{ SCC_ADD, "add name\n\n"
59*0Sstevel@tonic-gate 		"Add a new child entity to the currently selected entity."
60*0Sstevel@tonic-gate 	},
61*0Sstevel@tonic-gate 	{ SCC_DELETE, "delete [-f] {name | fmri | pattern}\n\n"
62*0Sstevel@tonic-gate "Delete the named child entity or the one indicated by fmri.  With -f, delete\n"
63*0Sstevel@tonic-gate "running services.\n"
64*0Sstevel@tonic-gate 	},
65*0Sstevel@tonic-gate 	{ SCC_SELECT, "select {name | fmri | pattern}\n\n"
66*0Sstevel@tonic-gate 		"Select the named child entity or the one indicated by fmri."
67*0Sstevel@tonic-gate 	},
68*0Sstevel@tonic-gate 	{ SCC_UNSELECT, "unselect\n\n"
69*0Sstevel@tonic-gate 		"Select the parent of the currently selected entity."
70*0Sstevel@tonic-gate 	},
71*0Sstevel@tonic-gate 	{ SCC_LISTPG, "listpg [glob_pattern]\n\n"
72*0Sstevel@tonic-gate 		"List property groups of the currently selected entity."
73*0Sstevel@tonic-gate 	},
74*0Sstevel@tonic-gate 	{ SCC_ADDPG, "addpg name type [P]\n\n"
75*0Sstevel@tonic-gate 		"Add a new property group to the currently selected entity."
76*0Sstevel@tonic-gate 	},
77*0Sstevel@tonic-gate 	{ SCC_DELPG, "delpg name\n\n"
78*0Sstevel@tonic-gate "Delete the named property group from the currently selected entity."
79*0Sstevel@tonic-gate 	},
80*0Sstevel@tonic-gate 	{ SCC_LISTPROP, "listprop [glob_pattern]\n\n"
81*0Sstevel@tonic-gate "List property groups and properties of the currently selected entity."
82*0Sstevel@tonic-gate 	},
83*0Sstevel@tonic-gate 	{ SCC_SETPROP,
84*0Sstevel@tonic-gate 		"\tsetprop pg/name = [type:] value\n"
85*0Sstevel@tonic-gate 		"\tsetprop pg/name = [type:] ([value...])\n\n"
86*0Sstevel@tonic-gate "Set the pg/name property of the currently selected entity.  Values may be\n"
87*0Sstevel@tonic-gate "enclosed in double-quotes.  Value lists may span multiple lines."
88*0Sstevel@tonic-gate 	},
89*0Sstevel@tonic-gate 	{ SCC_DELPROP, "delprop pg/name\n\n"
90*0Sstevel@tonic-gate 		"Delete the pg/name property of the currently selected entity."
91*0Sstevel@tonic-gate 	},
92*0Sstevel@tonic-gate 	{ SCC_EDITPROP, "editprop\n\n"
93*0Sstevel@tonic-gate "Invoke $EDITOR to edit the properties of the currently selected entity."
94*0Sstevel@tonic-gate 	},
95*0Sstevel@tonic-gate 	{ SCC_ADDPROPVALUE, "addpropvalue pg/name [type:] value\n\n"
96*0Sstevel@tonic-gate "Add the given value to the named property."
97*0Sstevel@tonic-gate 	},
98*0Sstevel@tonic-gate 	{ SCC_DELPROPVALUE, "delpropvalue pg/name glob_pattern\n\n"
99*0Sstevel@tonic-gate "Delete all values matching the glob pattern fron the given property."
100*0Sstevel@tonic-gate 	},
101*0Sstevel@tonic-gate 	{ SCC_SETENV, "setenv [-s | -i | -m method] NAME value\n\n"
102*0Sstevel@tonic-gate "Set an environment variable for the given service, instance, or method "
103*0Sstevel@tonic-gate "context."
104*0Sstevel@tonic-gate 	},
105*0Sstevel@tonic-gate 	{ SCC_UNSETENV, "unsetenv [-s | -i | -m method] NAME value\n\n"
106*0Sstevel@tonic-gate "Unset an environment variable for the given service, instance, or method "
107*0Sstevel@tonic-gate "context."
108*0Sstevel@tonic-gate 	},
109*0Sstevel@tonic-gate 	{ SCC_LISTSNAP, "listsnap\n\n"
110*0Sstevel@tonic-gate 		"List snapshots of the currently selected instance."
111*0Sstevel@tonic-gate 	},
112*0Sstevel@tonic-gate 	{ SCC_SELECTSNAP, "selectsnap [snapshot]\n\n"
113*0Sstevel@tonic-gate "Select a snapshot of the currently selected instance, or the Editing\n"
114*0Sstevel@tonic-gate "snapshot by default."
115*0Sstevel@tonic-gate 	},
116*0Sstevel@tonic-gate 	{ SCC_REVERT, "revert [snapshot]\n\n"
117*0Sstevel@tonic-gate "Change the properties of the currently selected instance and its ancestors\n"
118*0Sstevel@tonic-gate "to those in a snapshot, or the currently selected snapshot by default."
119*0Sstevel@tonic-gate 	},
120*0Sstevel@tonic-gate 	{ 0, NULL }
121*0Sstevel@tonic-gate };
122