forked from ElektraInitiative/libelektra
/
kdb-getmeta.1
97 lines (96 loc) · 2.23 KB
/
kdb-getmeta.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "KDB\-GETMETA" "1" "June 2019" "" ""
.
.SH "NAME"
\fBkdb\-getmeta\fR \- Get the value of a metakey stored in the key database
.
.SH "SYNOPSIS"
\fBkdb getmeta <key name> <metaname>\fR
.
.br
.
.P
Where \fBkey name\fR is the name of the key and \fBmetaname\fR is the name of the metakey the user would like to access\.
.
.SH "DESCRIPTION"
This command is used to print the value of a metakey\. A metakey is information stored in a key which describes that key\.
.
.P
The handling of cascading \fBkey name\fR does not differ to \fBkdb get\fR\. Make sure to use the namespace \fBspec\fR, if you want metadata from there\.
.
.SH "RETURN VALUES"
This command will return the following values as an exit status:
.
.br
.
.TP
0
No errors\.
.
.TP
1
Key not found\. (Invalid \fBpath\fR)
.
.TP
2
Meta key not found\. (Invalid \fBmetaname\fR)\.
.
.SH "OPTIONS"
.
.TP
\fB\-H\fR, \fB\-\-help\fR
Show the man page\.
.
.TP
\fB\-V\fR, \fB\-\-version\fR
Print version info\.
.
.TP
\fB\-p\fR, \fB\-\-profile <profile>\fR
Use a different kdb profile\.
.
.TP
\fB\-C\fR, \fB\-\-color <when>\fR
Print never/auto(default)/always colored output\.
.
.TP
\fB\-n\fR, \fB\-\-no\-newline\fR
Suppress the newline at the end of the output\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Explain what is happening\. Prints additional information in case of errors/warnings\.
.
.TP
\fB\-d\fR, \fB\-\-debug\fR
Give debug information\. Prints additional debug information in case of errors/warnings\.
.
.SH "EXAMPLES"
To get the value of a metakey called \fBdescription\fR stored in the key \fBspec/example/key\fR:
.
.br
\fBkdb getmeta spec/example/key description\fR
.
.P
To get the value of metakey called \fBoverride/#0\fR stored in the key \fBspec/example/dir/key\fR:
.
.br
\fBkdb getmeta spec/example/dir/key "override/#0"\fR
.
.SH "SEE ALSO"
.
.IP "\(bu" 4
How to set metadata: kdb\-setmeta(1) \fIkdb\-setmeta\.md\fR
.
.IP "\(bu" 4
For more about cascading keys see elektra\-cascading(7) \fIelektra\-cascading\.md\fR
.
.IP "\(bu" 4
elektra\-metadata(7) \fIelektra\-metadata\.md\fR for an explanation of the metadata concepts\.
.
.IP "\(bu" 4
elektra\-key\-names(7) \fIelektra\-key\-names\.md\fR for an explanation of key names\.
.
.IP "" 0