blob: 550b32be0284fc037e57d8df460f6cb9ec446985 [file] [log] [blame]
Joshua Brindle13cd4c82008-08-19 15:30:36 -04001.TH CHECKMODULE 8
2.SH NAME
3checkmodule \- SELinux policy module compiler
4.SH SYNOPSIS
5.B checkmodule
6.I "[-b] [-m] [-M] [-V] [-o output_file] [input_file]"
7.SH "DESCRIPTION"
8This manual page describes the
9.BR checkmodule
10command.
11.PP
12.B checkmodule
13is a program that checks and compiles a SELinux security policy module
14into a binary representation. It can generate either a base policy
15module (default) or a non-base policy module (-m option); typically,
16you would build a non-base policy module to add to an existing module
17store that already has a base module provided by the base policy. Use
18semodule_package to combine this module with its optional file
19contexts to create a policy package, and then use semodule to install
20the module package into the module store and load the resulting policy.
21
22.SH OPTIONS
23.TP
Guido Trentalanciabf57d232009-11-02 18:14:28 +010024.B \-b,\-\-binary
Joshua Brindle13cd4c82008-08-19 15:30:36 -040025Read an existing binary policy module file rather than a source policy
26module file. This option is a development/debugging aid.
27.TP
28.B \-m
29Generate a non-base policy module.
30.TP
Guido Trentalanciabf57d232009-11-02 18:14:28 +010031.B \-M,\-\-mls
Joshua Brindle13cd4c82008-08-19 15:30:36 -040032Enable the MLS/MCS support when checking and compiling the policy module.
33.TP
Guido Trentalanciabf57d232009-11-02 18:14:28 +010034.B \-V,\-\-version
Joshua Brindle13cd4c82008-08-19 15:30:36 -040035 Show policy versions created by this program
36.TP
Guido Trentalanciabf57d232009-11-02 18:14:28 +010037.B \-o,\-\-output filename
Joshua Brindle13cd4c82008-08-19 15:30:36 -040038Write a binary policy module file to the specified filename.
39Otherwise, checkmodule will only check the syntax of the module source file
40and will not generate a binary module at all.
Guido Trentalanciabf57d232009-11-02 18:14:28 +010041.TP
42.B \-U,\-\-handle-unknown <action>
43Specify how the kernel should handle unknown classes or permissions (deny, allow or reject).
Joshua Brindle13cd4c82008-08-19 15:30:36 -040044
45.SH EXAMPLE
46.nf
47# Build a MLS/MCS-enabled non-base policy module.
48$ checkmodule -M -m httpd.te -o httpd.mod
49.fi
50
51.SH "SEE ALSO"
52.B semodule(8), semodule_package(8)
53SELinux documentation at http://www.nsa.gov/selinux,
54especially "Configuring the SELinux Policy".
55
56
57.SH AUTHOR
58This manual page was copied from the checkpolicy man page
59written by Arpad Magosanyi <mag@bunuel.tii.matav.hu>,
60and edited by Dan Walsh <dwalsh@redhat.com>.
61The program was written by Stephen Smalley <sds@epoch.ncsc.mil>.