summaryrefslogtreecommitdiff
path: root/docs/capng_print_caps_text.3
diff options
context:
space:
mode:
Diffstat (limited to 'docs/capng_print_caps_text.3')
-rw-r--r--docs/capng_print_caps_text.324
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/capng_print_caps_text.3 b/docs/capng_print_caps_text.3
new file mode 100644
index 0000000..7310875
--- /dev/null
+++ b/docs/capng_print_caps_text.3
@@ -0,0 +1,24 @@
+.TH "CAPNG_PRINT_CAPS_NUMERIC" "3" "June 2009" "Red Hat" "Libcap-ng API"
+.SH NAME
+capng_print_caps_text \- print names of values for capabilities set
+.SH "SYNOPSIS"
+.B #include <cap-ng.h>
+.sp
+char *capng_print_caps_text(capng_print_t where, capng_type_t which);
+
+.SH "DESCRIPTION"
+
+capng_print_caps_text will create a text string representation of the internal capability set specified. 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.
+
+The legal values for the which paramemeter is CAPNG_EFFECTIVE, CAPNG_PERMITTED, CAPNG_INHERITABLE, or CAPNG_BOUNDING_SET.
+
+.SH "RETURN VALUE"
+
+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.
+
+.SH "SEE ALSO"
+
+.BR capabilities (7)
+
+.SH AUTHOR
+Steve Grubb