platform_external_selinux/libselinux/man/man3/selinux_boolean_sub.3
Guillem Jover 6ef13eeda7 libselinux: man: Fix man pages formatting
- Add man page sections '(N)' to external references, and '()' on
  functions described in the same man page.
- Escape minus signs when those are expected to be used on the command
  line or files.
- Mark files and variables in italic; Note headings, function names,
  constants, program options and man page references in bold.
- Do not justify and hyphenate SEE ALSO section, and avoid hyphenation
  on symbol names by prepending them with \%.
- Remove trailing dot from NAME section description.
- Split sections with a no-op command '.', to visually distinguish them
  but to avoid introducing spurious vertical space in the formatted
  output.
- Add explicit .sp commands in the SYNOPSIS section between function
  prototypes, and fix space placement in function protoypes.
- Split header includes with .br (instead of the explicit or implicit
  .sp) so that they are vertically contiguous.
- Add missing {} around SELINUXTYPE and POLICYTYPE variable text in
  paths.
- Remove unneeded formatting commands.
- Remove spurious blank lines.

Signed-off-by: Guillem Jover <guillem@debian.org>
Signed-off-by: Eric Paris <eparis@redhat.com>
Acked-by: Dan Walsh <dwalsh@redhat.com>
2013-02-05 20:14:43 -05:00

29 lines
805 B
Groff

.TH "selinux_boolean_sub" "3" "11 June 2012" "dwalsh@redhat.com" "SELinux API documentation"
.SH "NAME"
selinux_boolean_sub \-
.
.SH "SYNOPSIS"
.B #include <selinux/selinux.h>
.sp
.BI "char *selinux_boolean_sub(const char *" boolean_name ");"
.sp
.SH "DESCRIPTION"
.BR selinux_boolean_sub ()
searches the
.I \%/etc/selinux/{POLICYTYPE}/booleans.subs_dist
file
for a maching boolean_name record. If the record exists the boolean substitution name is returned. If not
.BR \%selinux_boolean_sub ()
returns the original
.IR \%boolean_name .
.SH "RETURN VALUE"
.BR selinux_boolean_sub ()
returns the
.I boolean_name
or the substituted name on success. The returned value must be freed with
.BR free "(3)."
.BR selinux_boolean_sub ()
returns NULL on error.
.SH "SEE ALSO"
.BR security_get_boolean_names (3)