klish.xsd 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://clish.sourceforge.net/XMLSchema" targetNamespace="http://clish.sourceforge.net/XMLSchema">
  3. <xs:annotation>
  4. <xs:appinfo>XML schema for klish configuration files</xs:appinfo>
  5. <xs:documentation xml:lang="en">
  6. The klish utility uses XML files for configuration. This schema
  7. allows to validate klish XML files. To check XML files use the
  8. following command:
  9. 'xmllint --schema /path/to/klish.xsd --noout *.xml'
  10. </xs:documentation>
  11. <xs:documentation xml:lang="ru">
  12. Утилита klish использует формат XML для своих конфигурационных
  13. файлов. Схема позволяет проверить эти конфигурационные XML файлы
  14. на правильность. Следующая команда выполнит проверку:
  15. 'xmllint --schema /path/to/klish.xsd --noout *.xml'
  16. </xs:documentation>
  17. </xs:annotation>
  18. <xs:element name="KLISH" type="klish_t"/>
  19. <xs:element name="ENTRY" type="entry_t"/>
  20. <xs:element name="VIEW" type="view_t"/> <!-- Wrapper -->
  21. <xs:element name="COMMAND" type="command_t"/> <!-- Wrapper -->
  22. <xs:element name="FILTER" type="command_t"/> <!-- Wrapper -->
  23. <xs:element name="STARTUP" type="startup_t"/>
  24. <xs:element name="ACTION" type="action_t"/>
  25. <xs:element name="OVERVIEW" type="overview_t"/>
  26. <xs:element name="DETAIL" type="detail_t"/>
  27. <xs:element name="PTYPE" type="ptype_t"/> <!-- Wrapper -->
  28. <xs:element name="PARAM" type="param_t"/> <!-- Wrapper -->
  29. <xs:element name="NAMESPACE" type="namespace_t"/> <!-- Wrapper -->
  30. <xs:element name="VAR" type="var_t"/>
  31. <xs:element name="WATCHDOG" type="wdog_t"/>
  32. <xs:element name="HOTKEY" type="hotkey_t"/>
  33. <xs:element name="PLUGIN" type="plugin_t"/>
  34. <xs:element name="HOOK" type="hook_t"/>
  35. <xs:complexType name="klish_t">
  36. <xs:annotation>
  37. <xs:documentation xml:lang="en">
  38. 'KLISH' is the top level container. Any object (command,
  39. type, var) which are defined within this tag are global
  40. in scope i.e. it is visible from all 'VIEW's.
  41. </xs:documentation>
  42. <xs:documentation xml:lang="ru">
  43. Тег 'KLISH' - контейнер верхнего уровня. Все остальные
  44. теги должны быть вложенными. Любой объект (команда,
  45. тип, переменная т.д.), заданный внутри этого тега,
  46. считается глобальным, т.е. видимым их любых 'VIEW".
  47. </xs:documentation>
  48. </xs:annotation>
  49. <xs:sequence>
  50. <xs:element ref="PLUGIN" minOccurs="0" maxOccurs="unbounded"/>
  51. <xs:element ref="HOOK" minOccurs="0" maxOccurs="unbounded"/>
  52. <xs:element ref="HOTKEY" minOccurs="0" maxOccurs="unbounded"/>
  53. <xs:element ref="WATCHDOG" minOccurs="0" maxOccurs="1"/>
  54. <xs:element ref="PTYPE" minOccurs="0" maxOccurs="unbounded"/>
  55. <xs:element ref="OVERVIEW" minOccurs="0"/>
  56. <xs:element ref="STARTUP" minOccurs="0"/>
  57. <xs:element ref="VAR" minOccurs="0" maxOccurs="unbounded"/>
  58. <xs:element ref="VIEW" minOccurs="0" maxOccurs="unbounded"/>
  59. <xs:element ref="ENTRY" minOccurs="0" maxOccurs="unbounded"/>
  60. </xs:sequence>
  61. </xs:complexType>
  62. <!--
  63. *******************************************************
  64. * <PTYPE> is used to define the syntax for a parameter type.
  65. *
  66. * name="<string>" - A textual name for this type. This name can be used to
  67. * reference this type within a PARAM's ptype attribute.
  68. *
  69. * help="<string>" - Help string.
  70. *
  71. ********************************************************
  72. -->
  73. <xs:complexType name="ptype_t">
  74. <xs:sequence>
  75. <xs:element ref="ACTION" minOccurs="0" maxOccurs="unbounded"/>
  76. </xs:sequence>
  77. <xs:attribute name="name" type="xs:string" use="required"/>
  78. <xs:attribute name="help" type="xs:string" use="required"/>
  79. </xs:complexType>
  80. <!--
  81. *******************************************************
  82. * <ENTRY> This tag is used to define wide class of elements.
  83. *
  84. * name - A text name for entry.
  85. *
  86. * help - A text string which describes the purpose of the entry.
  87. *
  88. * ptype - Reference to a PTYPE name. This parameter will be
  89. * validated against the syntax specified for that type.
  90. * The special value of "" indicates the parameter is a boolean flag.
  91. * The verbatim presence of the texual name on the command line
  92. * simply controls the conditional variable expansion for this
  93. * parameter.
  94. *
  95. * [mode] - Parameter mode. It can be "common", "switch", "subcommand", "multi".
  96. *
  97. * [prefix] - defines the prefix for an optional parameter. A prefix
  98. * with this value on the command line will signify the presence
  99. * of an additional argument which will be validated as the
  100. * value of this parameter.
  101. *
  102. * [optional] - Specify whether parameter is optional. The allowed values
  103. * is "true" or "false". It's false by default.
  104. *
  105. * [order] - Used only together with "optional=true" field.
  106. * If order="true" then user can't enter previously declared
  107. * optional parameters after current validated parameter.
  108. * The allowed values is "true" or "false". It's false by default.
  109. *
  110. * [default] - defines a default value for a parameter. Any parameters
  111. * at the end of command line which have default values need
  112. * not explicitly be entered.
  113. *
  114. * [value] - defines the user's value for subcommand. If this option
  115. * is defined the entered parameter will be compared to this
  116. * value instead the "name" field. If this field is defined
  117. * the mode of PARAM will be forced to "subcommand". The
  118. * feature is implemented to support subcommands with the
  119. * same names.
  120. *
  121. * [hidden] - define the visibility of the parameter while ${__line}
  122. * and ${__params} auto variables expanding. The allowed values
  123. * is "true" and "false".
  124. *
  125. * [test] - define the condition (see the description of 'test'
  126. * utility) to process this parameter.
  127. *
  128. * [access] - access rights
  129. *
  130. * [filter="true/false"] - Developer can define 'filter' command to filter stdout
  131. * of piped ("|") commands. Filter can't contain 'sync' ACTIONs. It will be
  132. * always fork()-ed. Only filters can be on the right hand to pipe "|".
  133. * Consider filters as a special type of commands.
  134. *
  135. ********************************************************
  136. -->
  137. <xs:simpleType name="entry_mode_t">
  138. <xs:restriction base="xs:string">
  139. <xs:enumeration value="sequence"/>
  140. <xs:enumeration value="switch"/>
  141. <xs:enumeration value="empty"/>
  142. </xs:restriction>
  143. </xs:simpleType>
  144. <xs:group name="entry_group_t">
  145. <xs:choice>
  146. <xs:element ref="ENTRY" minOccurs="0" maxOccurs="unbounded"/>
  147. <xs:element ref="ACTION" minOccurs="0" maxOccurs="unbounded"/>
  148. </xs:choice>
  149. </xs:group>
  150. <xs:complexType name="entry_t">
  151. <!-- Any order of tags and any number -->
  152. <xs:sequence>
  153. <xs:group ref="entry_group_t" minOccurs="0" maxOccurs="unbounded"/>
  154. </xs:sequence>
  155. <xs:attribute name="name" type="xs:string" use="required"/>
  156. <xs:attribute name="help" type="xs:string" use="optional"/>
  157. <xs:attribute name="container" type="xs:boolean" use="optional" default="false"/>
  158. <xs:attribute name="mode" type="param_mode_t" use="optional" default="switch"/>
  159. <xs:attribute name="min" type="xs:string" use="optional" default="1"/>
  160. <xs:attribute name="max" type="xs:string" use="optional" default="1"/>
  161. <xs:attribute name="ptype" type="xs:string" use="optional"/>
  162. <xs:attribute name="ref" type="xs:string" use="optional"/>
  163. <xs:attribute name="value" type="xs:string" use="optional"/>
  164. <xs:attribute name="restore" type="xs:boolean" use="optional" default="false"/>
  165. <xs:attribute name="order" type="xs:boolean" use="optional" default="false"/>
  166. <xs:attribute name="filter" type="xs:boolean" use="optional" default="false"/>
  167. </xs:complexType>
  168. <!--
  169. *******************************************************
  170. * <VIEW> defines the contents of a specific CLI view.
  171. *
  172. * name - a textual name for the view
  173. *
  174. * prompt - a textual definition of the prompt to be
  175. * used whilst in this view.
  176. * NB. The prompt may contain environment
  177. * or dynamic variables which are expanded
  178. * before display.
  179. *
  180. * [access] - access rights
  181. *
  182. ********************************************************
  183. -->
  184. <xs:complexType name="view_t">
  185. <xs:sequence>
  186. <xs:element ref="NAMESPACE" minOccurs="0" maxOccurs="unbounded"/>
  187. <xs:element ref="COMMAND" minOccurs="0" maxOccurs="unbounded"/>
  188. <xs:element ref="HOTKEY" minOccurs="0" maxOccurs="unbounded"/>
  189. <xs:element ref="ENTRY" minOccurs="0" maxOccurs="unbounded"/>
  190. </xs:sequence>
  191. <xs:attribute name="name" type="xs:string" use="required"/>
  192. <xs:attribute name="prompt" type="xs:string" use="optional"/>
  193. <xs:attribute name="access" type="xs:string" use="optional"/>
  194. </xs:complexType>
  195. <!--
  196. *******************************************************
  197. * <STARTUP> is used to define what happens when the CLI
  198. * is started. Any text held in a <DETAIL> sub-element will
  199. * be used as banner text, then any defined <ACTION> will be
  200. * executed. This action may provide Message Of The Day (MOTD)
  201. * type behaviour.
  202. *
  203. * view - defines the view which will be transitioned to, on
  204. * successful execution of any <ACTION> tag.
  205. *
  206. * [viewid] - defined the new value of the ${VIEWID} variable to
  207. * be used if a transition to a new view occurs.
  208. *
  209. * [default_shebang] - The default shebang for all commands.
  210. *
  211. * [timeout] - The idle timeout. The clish will exit if user
  212. * have not press any key while this timeout.
  213. *
  214. * [lock] - The same as lock for COMMAND tag.
  215. *
  216. * [interrupt] - The same as interrupt for COMMAND tag.
  217. *
  218. * [default_plugin] - Use (or don't use) default plugin.
  219. * It can be true or false.
  220. ********************************************************
  221. -->
  222. <xs:complexType name="startup_t">
  223. <xs:sequence>
  224. <xs:element ref="DETAIL" minOccurs="0"/>
  225. <xs:element ref="ACTION" minOccurs="0" maxOccurs="unbounded"/>
  226. </xs:sequence>
  227. <xs:attribute name="view" type="xs:string" use="required"/>
  228. <xs:attribute name="viewid" type="xs:string" use="optional"/>
  229. <xs:attribute name="default_shebang" type="xs:string" use="optional"/>
  230. <xs:attribute name="timeout" type="xs:string" use="optional"/>
  231. <xs:attribute name="default_plugin" type="xs:boolean" use="optional" default="true"/>
  232. </xs:complexType>
  233. <!--
  234. *******************************************************
  235. * <PARAM> This tag is used to define a parameter for a command.
  236. *
  237. * name - a textual name for this parameter.
  238. *
  239. * help - a textual string which describes the purpose of the
  240. * parameter.
  241. *
  242. * ptype - Reference to a PTYPE name. This parameter will be
  243. * validated against the syntax specified for that type.
  244. * The special value of "" indicates the parameter is a boolean flag.
  245. * The verbatim presence of the texual name on the command line
  246. * simply controls the conditional variable expansion for this
  247. * parameter.
  248. *
  249. * [mode] - Parameter mode. It can be "common", "switch", "subcommand", "multi".
  250. *
  251. * [prefix] - defines the prefix for an optional parameter. A prefix
  252. * with this value on the command line will signify the presence
  253. * of an additional argument which will be validated as the
  254. * value of this parameter.
  255. *
  256. * [optional] - Specify whether parameter is optional. The allowed values
  257. * is "true" or "false". It's false by default.
  258. *
  259. * [order] - Used only together with "optional=true" field.
  260. * If order="true" then user can't enter previously declared
  261. * optional parameters after current validated parameter.
  262. * The allowed values is "true" or "false". It's false by default.
  263. *
  264. * [default] - defines a default value for a parameter. Any parameters
  265. * at the end of command line which have default values need
  266. * not explicitly be entered.
  267. *
  268. * [value] - defines the user's value for subcommand. If this option
  269. * is defined the entered parameter will be compared to this
  270. * value instead the "name" field. If this field is defined
  271. * the mode of PARAM will be forced to "subcommand". The
  272. * feature is implemented to support subcommands with the
  273. * same names.
  274. *
  275. * [hidden] - define the visibility of the parameter while ${__line}
  276. * and ${__params} auto variables expanding. The allowed values
  277. * is "true" and "false".
  278. *
  279. * [test] - define the condition (see the description of 'test'
  280. * utility) to process this parameter.
  281. *
  282. * [access] - access rights
  283. *
  284. ********************************************************
  285. -->
  286. <xs:group name="param_group_t">
  287. <xs:choice>
  288. <xs:element ref="PARAM"/>
  289. <xs:element ref="ENTRY"/>
  290. </xs:choice>
  291. </xs:group>
  292. <xs:complexType name="param_t">
  293. <!-- Any order of tags and any number -->
  294. <xs:sequence>
  295. <xs:group ref="param_group_t" minOccurs="0" maxOccurs="unbounded"/>
  296. </xs:sequence>
  297. <xs:attribute name="name" type="xs:string" use="required"/>
  298. <xs:attribute name="help" type="xs:string" use="required"/>
  299. <xs:attribute name="ptype" type="xs:string" use="required"/>
  300. <xs:attribute name="mode" type="entry_mode_t" use="optional" default="common"/>
  301. <xs:attribute name="order" type="xs:boolean" use="optional" default="false"/>
  302. <xs:attribute name="value" type="xs:string" use="optional"/>
  303. </xs:complexType>
  304. <!--
  305. ********************************************************
  306. * <ACTION> specifies the action to be taken for
  307. * a command.
  308. *
  309. * In addition the optional 'sym' attribute can specify
  310. * the name of an internal command which will be invoked
  311. * to handle script.
  312. *
  313. * [sym="<symbol>"] - specify the name of an internally registered
  314. * function. The content of the ACTION tag is
  315. * taken as the arguments to this builtin function.
  316. *
  317. * [lock="<name>"] - Named lock. It will use special lockfile while
  318. * action execution.
  319. *
  320. * [interrupt="true/false"] - The boolean field that specify that action can be
  321. * be interrupted by Ctrl^C. Default is false. Ignored for non-interactive
  322. * actions.
  323. *
  324. * [interactive="true/false"] - Is action interactive.
  325. *
  326. * [exec_on="fail/success/always"] - ACTION's execution depends on
  327. * return code of previous elements of ACTION chain. If the
  328. * condition is not met then ACTION will not be executed. The "always"
  329. * value means that ACTION will be always executed and chain return
  330. * code will be ignored. Default is "success".
  331. *
  332. * [update_retcode="true/false"] - The chain return value can be updated
  333. * by current ACTION's return code or ACTION's return code can be ignored.
  334. * Default is "true".
  335. *
  336. * [permanent="true/false"] - The klish can be invoked with --dry-run option. In
  337. * this case all ACTIONs will be not actually executed but will always
  338. * return success. But some actions like navigation is necessary to be
  339. * executed in any case. Permanent flag will inform engine to always
  340. * execute ACTION.
  341. *
  342. * [sync="true/false"] - Common behaviour is to fork() process before ACTION
  343. * execution. But ACTION may be executed in-place (without fork()) if sync
  344. * flag is set to true. It's not recommended to use sync ACTIONs widely.
  345. * It's usefull for small fast functions only.
  346. *
  347. ********************************************************
  348. -->
  349. <xs:simpleType name="action_cond_t">
  350. <xs:restriction base="xs:string">
  351. <xs:enumeration value="fail"/>
  352. <xs:enumeration value="success"/>
  353. <xs:enumeration value="always"/>
  354. </xs:restriction>
  355. </xs:simpleType>
  356. <xs:complexType name="action_t">
  357. <xs:simpleContent>
  358. <xs:extension base="xs:string">
  359. <xs:attribute name="sym" type="xs:string" use="optional"/>
  360. <xs:attribute name="lock" type="xs:string" use="optional"/>
  361. <xs:attribute name="interrupt" type="xs:boolean" use="optional" default="false"/>
  362. <xs:attribute name="interactive" type="xs:boolean" use="optional" default="false"/>
  363. <xs:attribute name="exec_on" type="action_cond_t" use="optional" default="success"/>
  364. <xs:attribute name="update_retcode" type="xs:boolean" use="optional" default="true"/>
  365. <xs:attribute name="permanent" type="xs:boolean" use="optional" default="false"/>
  366. <xs:attribute name="sync" type="xs:boolean" use="optional" default="false"/>
  367. </xs:extension>
  368. </xs:simpleContent>
  369. </xs:complexType>
  370. <!--
  371. *******************************************************
  372. * <COMMAND> is used to define a command within the CLI.
  373. *
  374. * name="<string>" - A textual name for this command. (This may contain
  375. * spaces e.g. "display acl")
  376. *
  377. * help="<string>" - Help for command.
  378. *
  379. * [view] - defines the view which will be transitioned to, on
  380. * successful execution of any <ACTION> tag. By default the
  381. * current view stays in scope.
  382. *
  383. * [viewid] - defined the new value of the ${VIEWID} variable to
  384. * be used if a transition to a new view occurs. By default
  385. * the viewid will retain it's current value.
  386. *
  387. * [access] - defines the user group/level to which execution of this
  388. * command is restricted. By default there is no restriction.
  389. * The exact interpretation of this field is dependant on the
  390. * client of libclish but for example the clish and tclish
  391. * applications map this to the UNIX user groups.
  392. *
  393. * [escape_chars] - defines the characters which will be escaped (e.g. \$) before
  394. * being expanded as a variable. By default the following
  395. * characters will be escaped `|$<>&()#
  396. *
  397. * [args] - defines a parameter name to be used to gather the rest of the
  398. * command line after the formally defined parameters
  399. * (PARAM elements). The formatting of this parameter is a raw
  400. * string containing as many words as there are on the rest of the
  401. * command line.
  402. *
  403. * [args_help] - a textual string which describes the purpose of the 'args'
  404. * parameter. If the "args" attribute is given then this MUST be
  405. * given also.
  406. *
  407. ********************************************************
  408. -->
  409. <xs:complexType name="command_t">
  410. <xs:sequence>
  411. <xs:element ref="DETAIL" minOccurs="0"/>
  412. <!-- Any order of PARAM tags and any number -->
  413. <xs:group ref="param_group_t" minOccurs="0" maxOccurs="unbounded"/>
  414. <xs:element ref="ACTION" minOccurs="0" maxOccurs="unbounded"/>
  415. <xs:element ref="COMMAND" minOccurs="0" maxOccurs="unbounded"/>
  416. </xs:sequence>
  417. <xs:attribute name="name" type="xs:string" use="required"/>
  418. <xs:attribute name="help" type="xs:string" use="required"/>
  419. <xs:attribute name="ref" type="xs:string" use="optional"/>
  420. <xs:attribute name="view" type="xs:string" use="optional"/>
  421. <xs:attribute name="viewid" type="xs:string" use="optional"/>
  422. <xs:attribute name="access" type="xs:string" use="optional"/>
  423. <xs:attribute name="args" type="xs:string" use="optional"/>
  424. <xs:attribute name="args_help" type="xs:string" use="optional"/>
  425. <xs:attribute name="escape_chars" type="xs:string" use="optional"/>
  426. </xs:complexType>
  427. <!--
  428. ********************************************************
  429. * <OVERVIEW> specifies a textual description of the shell.
  430. *
  431. * This should provide instructions about key bindings and
  432. * escape sequences which can be used in the CLI.
  433. *
  434. ********************************************************
  435. -->
  436. <xs:simpleType name="overview_t">
  437. <xs:restriction base="xs:string">
  438. <xs:whiteSpace value="preserve"/>
  439. </xs:restriction>
  440. </xs:simpleType>
  441. <!--
  442. ********************************************************
  443. * <DETAIL> specifies a textual description.
  444. *
  445. * This may be used within the scope of a <COMMAND>
  446. * element, in which case it would typically contain
  447. * detailed usage instructions including examples.
  448. *
  449. * This may also be used within the scope of a <STARTUP>
  450. * element, in which case the text is used as the banner
  451. * details which are displayed on shell startup. This is
  452. * shown before any specified <ACTION> is executed.
  453. *
  454. * This text may also be used in the production of user manuals.
  455. ********************************************************
  456. -->
  457. <xs:simpleType name="detail_t">
  458. <xs:restriction base="xs:string">
  459. <xs:whiteSpace value="preserve"/>
  460. </xs:restriction>
  461. </xs:simpleType>
  462. <!--
  463. *******************************************************
  464. * <NAMESPACE> import commands from specific view to current view.
  465. *
  466. * ref - the view to import commands from
  467. *
  468. * [prefix] - the prefix for imported commands
  469. *
  470. * [prefix_help] - the help for namespace prefix
  471. *
  472. * [help] - a boolean flag to use imported
  473. * commands while help
  474. *
  475. * [completion] - a boolean flag to use imported
  476. * commands while completion
  477. *
  478. * [context_help] - a boolean flag to use imported
  479. * commands while context help
  480. *
  481. * [inherit] - a boolean flag to inherit nested
  482. * namespace commands recursively
  483. *
  484. * [access] - access rights
  485. *
  486. ********************************************************
  487. -->
  488. <xs:complexType name="namespace_t">
  489. <xs:attribute name="ref" type="xs:string" use="required"/>
  490. <xs:attribute name="prefix" type="xs:string" use="optional"/>
  491. <xs:attribute name="prefix_help" type="xs:string" use="optional"/>
  492. <xs:attribute name="help" type="xs:boolean" use="optional" default="false"/>
  493. <xs:attribute name="completion" type="xs:boolean" use="optional" default="true"/>
  494. <xs:attribute name="context_help" type="xs:boolean" use="optional" default="false"/>
  495. <xs:attribute name="inherit" type="xs:boolean" use="optional" default="true"/>
  496. <xs:attribute name="access" type="xs:string" use="optional"/>
  497. </xs:complexType>
  498. <!--
  499. *******************************************************
  500. * <VAR> Specify the variable.
  501. *
  502. *
  503. *
  504. ********************************************************
  505. -->
  506. <xs:complexType name="var_t">
  507. <xs:sequence>
  508. <xs:element ref="ACTION" minOccurs="0" maxOccurs="unbounded"/>
  509. </xs:sequence>
  510. <xs:attribute name="name" type="xs:string" use="required"/>
  511. <xs:attribute name="help" type="xs:string" use="optional"/>
  512. <xs:attribute name="value" type="xs:string" use="optional"/>
  513. <xs:attribute name="dynamic" type="xs:boolean" use="optional" default="false"/>
  514. </xs:complexType>
  515. <!--
  516. *******************************************************
  517. * <WATCHDOG> is used to recover system after errors.
  518. *
  519. ********************************************************
  520. -->
  521. <xs:complexType name="wdog_t">
  522. <xs:sequence>
  523. <xs:element ref="ACTION" minOccurs="1" maxOccurs="unbounded"/>
  524. </xs:sequence>
  525. </xs:complexType>
  526. <!--
  527. *******************************************************
  528. * <HOTKEY> is used to define hotkey actions
  529. *
  530. ********************************************************
  531. -->
  532. <xs:complexType name="hotkey_t">
  533. <xs:attribute name="key" type="xs:string" use="required"/>
  534. <xs:attribute name="cmd" type="xs:string" use="required"/>
  535. </xs:complexType>
  536. <!--
  537. *******************************************************
  538. * <PLUGIN> is used to dynamically load plugins.
  539. * Plugin contains symbols that can be used for ACTIONs.
  540. *
  541. * name - Plugin name. If "file" attribute is not specified then plugin's
  542. * filename is autogenerated as "klish-plugin-<name>.so".
  543. * [id] - Internal plugin name. Can be the same as "name".
  544. * [file] - File name if standard autogenerated filename (using "name" field)
  545. * is not appropriate.
  546. ********************************************************
  547. -->
  548. <xs:complexType name="plugin_t">
  549. <xs:simpleContent>
  550. <xs:extension base="xs:string">
  551. <xs:attribute name="name" type="xs:string" use="required"/>
  552. <xs:attribute name="id" type="xs:string" use="optional"/>
  553. <xs:attribute name="file" type="xs:string" use="optional"/>
  554. </xs:extension>
  555. </xs:simpleContent>
  556. </xs:complexType>
  557. <!--
  558. *******************************************************
  559. * <HOOK> is used to redefine internal hooks
  560. *
  561. * name - The name of internal hook (init, fini, access, log).
  562. *
  563. * [builtin] - specify the name of an internally registered
  564. * function.
  565. *
  566. ********************************************************
  567. -->
  568. <xs:simpleType name="hook_list_e">
  569. <xs:restriction base="xs:string">
  570. <xs:enumeration value="init"/>
  571. <xs:enumeration value="fini"/>
  572. <xs:enumeration value="access"/>
  573. <xs:enumeration value="log"/>
  574. </xs:restriction>
  575. </xs:simpleType>
  576. <xs:complexType name="hook_t">
  577. <xs:attribute name="name" type="hook_list_e"/>
  578. <xs:attribute name="builtin" type="xs:string" use="optional"/>
  579. </xs:complexType>
  580. </xs:schema>