svccfg_help.c revision 11996:91b62f7b8186
10SN/A/* 213915Sjjg * CDDL HEADER START 30SN/A * 40SN/A * The contents of this file are subject to the terms of the 50SN/A * Common Development and Distribution License (the "License"). 60SN/A * You may not use this file except in compliance with the License. 72362SN/A * 80SN/A * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 92362SN/A * or http://www.opensolaris.org/os/licensing. 100SN/A * See the License for the specific language governing permissions 110SN/A * and limitations under the License. 120SN/A * 130SN/A * When distributing Covered Code, include this CDDL HEADER in each 140SN/A * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 150SN/A * If applicable, add the following below this CDDL HEADER, with the 160SN/A * fields enclosed by brackets "[]" replaced with your own identifying 170SN/A * information: Portions Copyright [yyyy] [name of copyright owner] 180SN/A * 190SN/A * CDDL HEADER END 200SN/A */ 212362SN/A 222362SN/A/* 232362SN/A * Copyright 2010 Sun Microsystems, Inc. All rights reserved. 240SN/A * Use is subject to license terms. 250SN/A */ 260SN/A 270SN/A 280SN/A#include "svccfg.h" 290SN/A#include "svccfg_grammar.h" 300SN/A 310SN/Astruct help_message help_messages[] = { 320SN/A { SCC_VALIDATE, "validate [file | fmri]\n\n" 330SN/A"Validate a manifest file without changing the repository.\n" 340SN/A"Validate an instance FMRI against the template specifications." 350SN/A }, 360SN/A { SCC_IMPORT, "import [-p outfile] [-V] paths...\n\n" 370SN/A"Import manifests into the repository. paths can be one or more\n" 380SN/A"manifest files or directories. If directories are specified, they\n" 390SN/A"will be searched for files with a .xml extension. If -p is specified,\n" 400SN/A"a progress message will be written to outfile as each manifest is\n" 410SN/A"imported. With -V force strict adherence to the template specifications." 420SN/A }, 430SN/A { SCC_EXPORT, "export [-a] {service | pattern} [> file]\n\n" 440SN/A"Print a manifest for service to file, or standard output if not specified." 450SN/A }, 460SN/A { SCC_ARCHIVE, "archive [-a] [> file]\n\n" 470SN/A"Print an archive to file, or standard output if not specified." 480SN/A }, 490SN/A { SCC_RESTORE, "restore file\n\n" 500SN/A"Restore the contents of a previously-generated archive." 510SN/A }, 520SN/A { SCC_APPLY, "apply file\n\nApply a profile." }, 530SN/A { SCC_EXTRACT, "extract [> file]\n\n" 540SN/A"Print a profile to file, or standard output if not specified." }, 550SN/A { SCC_REPOSITORY, "repository file\n\nSet the repository to modify." }, 560SN/A { SCC_INVENTORY, "inventory file\n\n" 570SN/A "Print the services and instances contained in a manifest." 580SN/A }, 590SN/A { SCC_SET, "set [-vV]\n\n" 600SN/A"Without arguments, display current options. Otherwise set the given options." 610SN/A }, 620SN/A { SCC_END, "end\n\nStop processing and exit." }, 630SN/A { SCC_HELP, "help [command]\n\nDisplay help." }, 640SN/A { SCC_LIST, "list [glob_pattern]\n\n" 650SN/A "List children of the currently selected entity." 660SN/A }, 670SN/A { SCC_ADD, "add name\n\n" 680SN/A "Add a new child entity to the currently selected entity." 690SN/A }, 7013915Sjjg { SCC_DELETE, "delete [-f] {name | fmri | pattern}\n\n" 710SN/A"Delete the named child entity or the one indicated by fmri. With -f, delete\n" 720SN/A"running services.\n" 730SN/A }, 740SN/A { SCC_SELECT, "select {name | fmri | pattern}\n\n" 750SN/A "Select the named child entity or the one indicated by fmri." 760SN/A }, 770SN/A { SCC_UNSELECT, "unselect\n\n" 780SN/A "Select the parent of the currently selected entity." 790SN/A }, 800SN/A { SCC_LISTPG, "listpg [glob_pattern]\n\n" 810SN/A "List property groups of the currently selected entity." 820SN/A }, 830SN/A { SCC_ADDPG, "addpg name type [P]\n\n" 840SN/A "Add a new property group to the currently selected entity." 850SN/A }, 860SN/A { SCC_DELPG, "delpg name\n\n" 870SN/A"Delete the named property group from the currently selected entity." 880SN/A }, 890SN/A { SCC_DELHASH, "delhash [-d] manifest\n\n" 906899SN/A"Delete the named manifest hash entry (from smf/manifest).\n" 916899SN/A"With -d, manifest file doesn't need to exist." 926899SN/A }, 930SN/A { SCC_CLEANUP, "cleanup\n\n" 940SN/A"Cleanup any service or instances that no longer have manifest files that\n" 950SN/A"support the services or instances in /lib/svc/manifest or /var/svc/manifest." 960SN/A }, 970SN/A { SCC_LISTPROP, "listprop [glob_pattern]\n\n" 980SN/A"List property groups and properties of the currently selected entity." 990SN/A }, 1000SN/A { SCC_SETPROP, 1010SN/A "\tsetprop pg/name = [type:] value\n" 1020SN/A "\tsetprop pg/name = [type:] ([value...])\n\n" 1030SN/A"Set the pg/name property of the currently selected entity. Values may be\n" 1040SN/A"enclosed in double-quotes. Value lists may span multiple lines." 1050SN/A }, 1060SN/A { SCC_DELPROP, "delprop pg/name\n\n" 1070SN/A "Delete the pg/name property of the currently selected entity." 1080SN/A }, 1090SN/A { SCC_EDITPROP, "editprop\n\n" 1100SN/A"Invoke $EDITOR to edit the properties of the currently selected entity." 1110SN/A }, 1120SN/A { SCC_DESCRIBE, "describe [-v] [-t] [propertygroup/property]\n\n" 1130SN/A"Describe the current properties. With -v, describe verbosely. With -t,\n" 1140SN/A"show only template data, not current properties." 1150SN/A }, 1160SN/A { SCC_ADDPROPVALUE, "addpropvalue pg/name [type:] value\n\n" 1170SN/A"Add the given value to the named property." 1180SN/A }, 1190SN/A { SCC_DELPROPVALUE, "delpropvalue pg/name glob_pattern\n\n" 1200SN/A"Delete all values matching the glob pattern fron the given property." 1210SN/A }, 1220SN/A { SCC_SETENV, "setenv [-s | -i | -m method] NAME value\n\n" 1230SN/A"Set an environment variable for the given service, instance, or method " 1240SN/A"context." 1250SN/A }, 1260SN/A { SCC_UNSETENV, "unsetenv [-s | -i | -m method] NAME value\n\n" 1270SN/A"Unset an environment variable for the given service, instance, or method " 1280SN/A"context." 1290SN/A }, 1300SN/A { SCC_LISTSNAP, "listsnap\n\n" 1310SN/A "List snapshots of the currently selected instance." 1320SN/A }, 1330SN/A { SCC_SELECTSNAP, "selectsnap [snapshot]\n\n" 1340SN/A"Select a snapshot of the currently selected instance, or the Editing\n" 1350SN/A"snapshot by default." 1360SN/A }, 1370SN/A { SCC_REVERT, "revert [snapshot]\n\n" 1380SN/A"Change the properties of the currently selected instance and its ancestors\n" 1390SN/A"to those in a snapshot, or the currently selected snapshot by default." 1400SN/A }, 1410SN/A { SCC_REFRESH, "refresh\n\n" 1420SN/A"Commit the values from the current configuration to the running\n" 1430SN/A"snapshot, making them available for use by the currently selected\n" 1440SN/A"instance. If the repository subcommand has not been used to select\n" 1450SN/A"a repository, inform the instance's restarter to re-read the updated\n" 1460SN/A"configuration." 1470SN/A }, 1480SN/A { 0, NULL } 1490SN/A}; 1500SN/A