Imported Upstream version 0.8.4
[platform/upstream/libcap-ng.git] / docs / capng_print_caps_numeric.3
1 .TH "CAPNG_PRINT_CAPS_NUMERIC" "3" "Sept 2020" "Red Hat" "Libcap-ng API"
2 .SH NAME
3 capng_print_caps_numeric \- print numeric values for capabilities set
4 .SH "SYNOPSIS"
5 .B #include <cap-ng.h>
6 .sp
7 char *capng_print_caps_numeric(capng_print_t where, capng_select_t set);
8
9 .SH "DESCRIPTION"
10
11 capng_print_caps_numeric will create a numeric representation of the internal capabilities. The representation can be sent to either stdout or a buffer by passing CAPNG_PRINT_STDOUT or CAPNG_PRINT_BUFFER respectively for the where parameter. If the option was for a buffer, this function will malloc a buffer that the caller must free.
12
13 The set parameter controls what is included in the representation. The legal options are CAPNG_SELECT_CAPS for the traditional capabilities, CAPNG_SELECT_BOUNDS for the bounding set, CAPNG_SELECT_BOTH if printing both is desired, CAPNG_SELECT_AMBIENT if only printing the ambient capabilities, or CAPNG_SELECT_ALL if printing all is desired.
14
15 .SH "RETURN VALUE"
16
17 If CAPNG_PRINT_BUFFER was selected for where, this will be the text buffer and NULL on failure. If CAPNG_PRINT_STDOUT was selected then this value will be NULL no matter what.
18
19 .SH "SEE ALSO"
20
21 .BR capng_print_caps_text (3),
22 .BR capabilities (7)
23
24 .SH AUTHOR
25 Steve Grubb