Skip to content
Newer
Older
100644 42 lines (27 sloc) 1 KB
8a5c6de @mauke add some docs
authored May 30, 2010
1 =pod
2
3 =head1 NAME
4
699ecf4 @mauke provide access to the shorter capnames
authored Jul 30, 2011
5 unibi_name_bool, unibi_name_num, unibi_name_str, unibi_short_name_bool, unibit_short_name_num, unibi_short_name_str - translate capability enums to names
8a5c6de @mauke add some docs
authored May 29, 2010
6
7 =head1 SYNOPSIS
8
0e394fd @mauke change to <unibilium.h> in the documentation
authored Mar 27, 2012
9 #include <unibilium.h>
8a5c6de @mauke add some docs
authored May 29, 2010
10
11 const char *unibi_name_bool(enum unibi_boolean b);
12 const char *unibi_name_num(enum unibi_numeric n);
13 const char *unibi_name_str(enum unibi_string s);
699ecf4 @mauke provide access to the shorter capnames
authored Jul 30, 2011
14
15 const char *unibi_short_name_bool(enum unibi_boolean b);
16 const char *unibi_short_name_num(enum unibi_numeric n);
17 const char *unibi_short_name_str(enum unibi_string s);
8a5c6de @mauke add some docs
authored May 29, 2010
18
19 =head1 DESCRIPTION
20
699ecf4 @mauke provide access to the shorter capnames
authored Jul 30, 2011
21 These functions return the names of capabilities as strings. By default long
22 names ("variable names") are returned; the C<unibi_short_name_*> variants use
23 the shorter "capnames".
8a5c6de @mauke add some docs
authored May 29, 2010
24
25 =head1 EXAMPLE
26
27 #include <stdio.h>
0e394fd @mauke change to <unibilium.h> in the documentation
authored Mar 26, 2012
28 #include <unibilium.h>
8a5c6de @mauke add some docs
authored May 29, 2010
29
30 int main(void) {
699ecf4 @mauke provide access to the shorter capnames
authored Jul 30, 2011
31 printf("%s - %s\n", unibi_name_bool(unibi_has_status_line), unibi_short_name_bool(unibi_has_status_line));
8a5c6de @mauke add some docs
authored May 29, 2010
32 /* Output:
699ecf4 @mauke provide access to the shorter capnames
authored Jul 30, 2011
33 has_status_line - hs
8a5c6de @mauke add some docs
authored May 29, 2010
34 */
35 }
36
37 =head1 SEE ALSO
38
39 L<unibilium.h(3)>
40
41 =cut
Something went wrong with that request. Please try again.