Example of Full Library Utilization: kdb command

Functions
int	commandRemove ()
int	commandSet ()
int	commandLink ()
int	commandList ()
int	commandGet ()
int	commandEdit ()
int	commandImport ()
int	commandExport ()
int	commandMonitor ()

---

Function Documentation

int commandEdit (   )

Opens an editor to edit an XML representation of the keys. This is one of the most complex commands of the kdb program. Is will retrieve the desired keys put them as inside an editor in an XML format to let the user edit wait for the editor to finish reread the edited XML, converting to an internal KeySet compare original and edited KeySets to detect differences remove removed keys update updated keys add added keys leave untouched the not changed keys Example: bash$ EDITOR=kedit kdb edit -R user/env # edit with kedit bash# kdb edit -R system/sw/MyApp # defaults to vi editor See also: keyCompare() ksCompare() kdbGetChildKeys() ksToStream() kdbSetKeys() Parameters: argKeyName  the parent key name (and children) that will be edited argRecursive  whether to act recursivelly or not argAll  whether to edit inactive keys or not EDITOR  environment var that defines editor to use, or vi Definition at line 999 of file kdb.c. References KDB_O_NFOLLOWLINK, KDB_O_SORT, KDB_O_XMLHEADERS, kdbGetChildKeys(), kdbGetKey(), kdbRemove(), kdbSetKeys(), keyClose(), keyGetFullName(), keyInit(), keySetName(), ksAppend(), ksCompare(), ksInit(), ksNext(), ksRewind(), and ksToStream().

int commandExport (   )

Business logic behind the 'kdb export' command. Export a set of keys to an XML format. Usefull to make backups or copy keys to other machine or user. Equivalent to 'kdb ls -xRv base/key/name' Example: bash# kdb export system > systemConfigurationBackup.xml bash# kdb export system/sw/MyApp > myAppConfiguration.xml bash$ kdb export system/sw/MyApp | sed -e 's|system/sw|user/sw|g' | kdb import See also: commandList() commandImport() Definition at line 1121 of file kdb.c. References commandList().

int commandGet (   )

Business logic behind the 'kdb get' command. Get a key and return its value to you. Example: bash$ kdb get user/env/alias/ls ls -Fh --color=tty Parameters: argKeyName  key to get value argDescriptive  show also the key comment (-d) argShell  output suitable for shell scripts (-s) argLong  show also the key name (-l) argFullName  with argLong, show the user domain too (-f) See also: kdbGetKey() kdbGetBaseName() keyGetComment() keyGetString() Definition at line 664 of file kdb.c. References kdbGetKey(), KEY_TYPE_BINARY, keyGetBaseName(), keyGetBaseNameSize(), keyGetComment(), keyGetCommentSize(), keyGetDataSize(), keyGetFullName(), keyGetFullNameSize(), keyGetName(), keyGetNameSize(), keyGetString(), keyGetType(), keyInit(), and keySetName().

int commandImport (   )

Business logic behind the 'kdb import' command. Import an XML file (or standard input) into the key database. This is usefull to import full programs keys, or restore backups. Example: bash$ kdb import myAppDefaultKeys.xml bash$ generateKeys | kdb import See also: kdbSetKeys() commandSave() Definition at line 1088 of file kdb.c. References kdbSetKeys(), and ksInit().

int commandLink (   )

The business logic behind 'kdb ln' command Example: bash$ kdb ln user:valeria/sw/MyApp user/sw/MyApp # make my personal MyApp configurations be a link to valerias configs See also: kdbLink() keySetType() Parameters: argKeyName  name of the target key argData  name of the link key to be created Definition at line 480 of file kdb.c. References kdbLink().

int commandList (   )

The business logic behind 'kdb ls' command. Parameters: argKeyName  key name to be listed argRecursive  whether to act recursivelly (-R) argValue  whether to show key values or not (-v) argAll  whether to list also inactive keys (-a) argXML  whether to create XML output (-x) Example: bash$ kdb ls -R # list all keys from system and user trees bash$ kdb ls -Ra # list them all plus the hidden/inactive keys bash$ kdb ls -Rav # list all showing value bash# kdb ls -Rxv # equivalent to 'kdb export' bash$ kdb ls -Rv user/env # list my aliases and environment vars See also: kdbGetRootKeys() kdbGetChildKeys() keyToStream() ksToStream() commandExport() for the 'kdb export' command Definition at line 537 of file kdb.c. References KDB_O_DIR, KDB_O_NFOLLOWLINK, KDB_O_STATONLY, KDB_O_XMLHEADERS, kdbGetChildKeys(), kdbGetKey(), kdbGetRootKeys(), kdbStatKey(), keyClose(), keyGetFullName(), keyInit(), keySetName(), keyToStream(), ksAppend(), ksAppendKeys(), ksClose(), ksInit(), ksNext(), ksRewind(), and ksToStream(). Referenced by commandExport().

int commandMonitor (   )

Business logic behind 'kdb mon' command. Will block your command line until some change happens to the interested key. Example: bash$ kdb mon system/sw/MyApp/someKey See also: kdbMonitorKey() kdbMonitorKeys() Definition at line 1155 of file kdb.c. References kdbGetKey(), kdbMonitorKey(), KEY_FLAG_HASDATA, keyGetDataSize(), keyGetString(), keyInit(), and keySetName().

int commandRemove (   )

The business logic behind 'kdb rm' command Example: bash$ kdb rm user/env/alias/ls # get rid to the ls alias See also: kdbRemove() Parameters: argKeyName  name of the key that will be removed Definition at line 377 of file kdb.c. References kdbRemove().

int commandSet (   )

The business logic behind 'kdb set' command. Sets value to a single key. Example: bash$ kdb set -c "My shell prompt" user/env/env1/PS1 '\h:\w\$' See also: kdbSetKey() Parameters: argKeyName  name of the key that will be set argComment  comment to be set to key (-c) argType  type of the key (-t) argMode  access permissions that will be set to sey (-m) argUID  UID to be set to sey argGID  GID to be set to sey argData  the value to the key Definition at line 413 of file kdb.c. References KDB_RET_NOTFOUND, kdbGetKey(), kdbSetKey(), KEY_TYPE_BINARY, KEY_TYPE_DIR, KEY_TYPE_LINK, KEY_TYPE_STRING, KEY_TYPE_UNDEFINED, keyGetType(), keyInit(), keySetAccess(), keySetBinary(), keySetComment(), keySetGID(), keySetName(), keySetString(), keySetType(), and keySetUID().

---