.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "doc::unibi_short_name_bool 3" .TH doc::unibi_short_name_bool 3 2024-03-17 unibilium-2.1.1 unibilium .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME 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 .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& #include \& \& const char *unibi_name_bool(enum unibi_boolean b); \& const char *unibi_name_num(enum unibi_numeric n); \& const char *unibi_name_str(enum unibi_string s); \& \& const char *unibi_short_name_bool(enum unibi_boolean b); \& const char *unibi_short_name_num(enum unibi_numeric n); \& const char *unibi_short_name_str(enum unibi_string s); .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" These functions return the names of capabilities as strings. By default long names ("variable names") are returned; the \f(CW\*(C`unibi_short_name_*\*(C'\fR variants use the shorter "capnames". .SH EXAMPLE .IX Header "EXAMPLE" .Vb 2 \& #include \& #include \& \& int main(void) { \& printf("%s \- %s\en", unibi_name_bool(unibi_has_status_line), unibi_short_name_bool(unibi_has_status_line)); \& /* Output: \& has_status_line \- hs \& */ \& } .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBunibilium.h\fR\|(3)