diff options
author | 2014-10-13 16:49:41 -0400 | |
---|---|---|
committer | 2014-10-13 16:49:47 -0400 | |
commit | 3caa89b8d2b99fd42d9c9a7aa0cfc929945f124a (patch) | |
tree | d2a24f67162aed911ab2477a12bdfd9e07e72463 | |
parent | misc/install-xattr: fix whitespace in ChangeLog (diff) | |
download | elfix-3caa89b8d2b99fd42d9c9a7aa0cfc929945f124a.tar.gz elfix-3caa89b8d2b99fd42d9c9a7aa0cfc929945f124a.tar.bz2 elfix-3caa89b8d2b99fd42d9c9a7aa0cfc929945f124a.zip |
doc: update pod files
-rw-r--r-- | doc/paxctl-ng.1 | 61 | ||||
-rw-r--r-- | doc/paxctl-ng.pod | 5 | ||||
-rw-r--r-- | doc/revdep-pax.1 | 70 | ||||
-rw-r--r-- | doc/revdep-pax.pod | 18 |
4 files changed, 70 insertions, 84 deletions
diff --git a/doc/paxctl-ng.1 b/doc/paxctl-ng.1 index 5cb923a..72d57cb 100644 --- a/doc/paxctl-ng.1 +++ b/doc/paxctl-ng.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.23) +.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== @@ -38,6 +38,8 @@ . ds PI \(*p . ds L" `` . ds R" '' +. ds C` +. ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. @@ -48,17 +50,24 @@ .\" 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. -.ie \nF \{\ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX .. -. nr % 0 -. rr F -.\} -.el \{\ -. 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -124,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "PAXCTL-NG 1" -.TH PAXCTL-NG 1 "2014-07-30" "elfix 0.9" "Documentation for elfix" +.TH PAXCTL-NG 1 "2014-10-13" "elfix 0.9" "Documentation for elfix" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -147,7 +156,7 @@ paxctl\-ng \- get, set or create either PT_PAX or XATTR_PAX flags \&\fBpaxctl-ng\fR is used to get, set or create the PaX flags on \s-1ELF\s0 executables which determine the memory restrictions on process(es) spawned from them when run under a PaX enabled kernel. \fBpaxctl-ng\fR manages two types of markings, either the older -style \s-1PT_PAX\s0 markings which put the flags in an \s-1ELF\s0 program header named \s-1PAX_FLAGS\s0, +style \s-1PT_PAX\s0 markings which put the flags in an \s-1ELF\s0 program header named \s-1PAX_FLAGS,\s0 or the newer style \s-1XATTR_PAX\s0 markings which put the flags in an extended attribute field named user.pax.flags on the filesystem. Whenever possible, \fBpaxctl-ng\fR will try to set both \s-1PT_PAX\s0 and \s-1XATTR_PAX\s0 to the same flags. @@ -169,7 +178,7 @@ are carried within the binary itself. \&\fBpaxctl-ng\fR is opportunistic without taking control away from the user. If both a \s-1PAX_FLAGS\s0 program header and a user.pax.flags extended attribute field exist, then both will be equally updated when the user modifies flags; unless the \fB\-L\fR or \fB\-l\fR -flags are given, in which case the markings are limiting to just \s-1PT_PAX\s0 or \s-1XATTR_PAX\s0, +flags are given, in which case the markings are limiting to just \s-1PT_PAX\s0 or \s-1XATTR_PAX,\s0 respectively. If only one marking is possible, then only that marking will be updated. Under no circumstances will \fBpaxctl-ng\fR create a \s-1PAX_FLAGS\s0 program header as \fBpaxctl\fR does. It will only attempt to create an extended attribute field if it is instructed @@ -182,22 +191,20 @@ Finally, if the user wishes, he can remove the extended attribute field by runni .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-P\fR or \fB\-p\fR Enable or disable \s-1PAGEEXEC\s0" 4 -.IX Item "-P or -p Enable or disable PAGEEXEC" +.IX Item "-P or -p Enable or disable PAGEEXEC" .PD 0 .IP "\fB\-S\fR or \fB\-s\fR Enable or disable \s-1SEGMEXEC\s0" 4 -.IX Item "-S or -s Enable or disable SEGMEXEC" +.IX Item "-S or -s Enable or disable SEGMEXEC" .IP "\fB\-M\fR or \fB\-m\fR Enable or disable \s-1MPROTECT\s0" 4 -.IX Item "-M or -m Enable or disable MPROTECT" +.IX Item "-M or -m Enable or disable MPROTECT" .IP "\fB\-E\fR or \fB\-e\fR Enable or disable \s-1EMUTRAMP\s0" 4 -.IX Item "-E or -e Enable or disable EMUTRAMP" +.IX Item "-E or -e Enable or disable EMUTRAMP" .IP "\fB\-R\fR or \fB\-r\fR Enable or disable \s-1RANDMMAP\s0" 4 -.IX Item "-R or -r Enable or disable RANDMMAP" +.IX Item "-R or -r Enable or disable RANDMMAP" .IP "\fB\-X\fR or \fB\-x\fR Enable or disable \s-1RANDEXEC\s0" 4 -.IX Item "-X or -x Enable or disable RANDEXEC" -.IP "" 4 +.IX Item "-X or -x Enable or disable RANDEXEC" .PD -If both enabling and disabling flags are set for one item, -eg. \-Pp for \s-1PAGEEXEC\s0, then the default setting '\-' is used. +If both enabling and disabling flags are set for one item, eg. \-Pp for \s-1PAGEEXEC,\s0 then the default setting '\-' is used. .IP "\fB\-Z\fR Set most secure settings (PSMeRx)." 4 .IX Item "-Z Set most secure settings (PSMeRx)." .PD 0 @@ -210,14 +217,14 @@ eg. \-Pp for \s-1PAGEEXEC\s0, then the default setting '\-' is used. .ie n .IP "\fB\-d\fR Delete \s-1XATTR_PAX\s0 field, ""user.pax.flags""." 4 .el .IP "\fB\-d\fR Delete \s-1XATTR_PAX\s0 field, ``user.pax.flags''." 4 .IX Item "-d Delete XATTR_PAX field, user.pax.flags." -.IP "\fB\-F\fR Copy \s-1PT_PAX\s0 flags to \s-1XATTR_PAX\s0, if possible." 4 +.IP "\fB\-F\fR Copy \s-1PT_PAX\s0 flags to \s-1XATTR_PAX,\s0 if possible." 4 .IX Item "-F Copy PT_PAX flags to XATTR_PAX, if possible." -.IP "\fB\-f\fR Copy \s-1XATTR_PAX\s0 flags to \s-1PT_PAX\s0, if possible." 4 +.IP "\fB\-f\fR Copy \s-1XATTR_PAX\s0 flags to \s-1PT_PAX,\s0 if possible." 4 .IX Item "-f Copy XATTR_PAX flags to PT_PAX, if possible." -.IP "\fB\-L\fR When given with other flags, only set \s-1PT_PAX\s0 flags, if possible. When given alone, return \s-1EXIT_SUCCESS\s0 if \s-1PT_PAX\s0 is supported, else return \s-1EXIT_FAILURE\s0." 4 -.IX Item "-L When given with other flags, only set PT_PAX flags, if possible. When given alone, return EXIT_SUCCESS if PT_PAX is supported, else return EXIT_FAILURE." -.IP "\fB\-l\fR When given with other flags, only set \s-1XATTR_PAX\s0 flags, if possible. When given alone, return \s-1EXIT_SUCCESS\s0 if \s-1XATTR_PAX\s0 is supported, else return \s-1EXIT_FAILURE\s0." 4 -.IX Item "-l When given with other flags, only set XATTR_PAX flags, if possible. When given alone, return EXIT_SUCCESS if XATTR_PAX is supported, else return EXIT_FAILURE." +.IP "\fB\-L\fR When given with other flags, only set \s-1PT_PAX\s0 flags, if possible. When given alone, return \s-1EXIT_SUCCESS\s0 if \s-1PT_PAX\s0 is supported, else return \s-1EXIT_FAILURE.\s0" 4 +.IX Item "-L When given with other flags, only set PT_PAX flags, if possible. When given alone, return EXIT_SUCCESS if PT_PAX is supported, else return EXIT_FAILURE." +.IP "\fB\-l\fR When given with other flags, only set \s-1XATTR_PAX\s0 flags, if possible. When given alone, return \s-1EXIT_SUCCESS\s0 if \s-1XATTR_PAX\s0 is supported, else return \s-1EXIT_FAILURE.\s0" 4 +.IX Item "-l When given with other flags, only set XATTR_PAX flags, if possible. When given alone, return EXIT_SUCCESS if XATTR_PAX is supported, else return EXIT_FAILURE." .IP "\fB\-v\fR View the flags" 4 .IX Item "-v View the flags" .IP "\fB\-h\fR Print out a short help message and exit." 4 diff --git a/doc/paxctl-ng.pod b/doc/paxctl-ng.pod index d409a09..99b79a1 100644 --- a/doc/paxctl-ng.pod +++ b/doc/paxctl-ng.pod @@ -68,10 +68,7 @@ B<paxctl-ng> with the B<-d> flag. =item B<-X> or B<-x> Enable or disable RANDEXEC -=item - -If both enabling and disabling flags are set for one item, -eg. -Pp for PAGEEXEC, then the default setting '-' is used. +If both enabling and disabling flags are set for one item, eg. -Pp for PAGEEXEC, then the default setting '-' is used. =item B<-Z> Set most secure settings (PSMeRx). diff --git a/doc/revdep-pax.1 b/doc/revdep-pax.1 index ee7cfd5..cb76b52 100644 --- a/doc/revdep-pax.1 +++ b/doc/revdep-pax.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.23) +.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== @@ -38,6 +38,8 @@ . ds PI \(*p . ds L" `` . ds R" '' +. ds C` +. ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. @@ -48,17 +50,24 @@ .\" 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. -.ie \nF \{\ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX .. -. nr % 0 -. rr F -.\} -.el \{\ -. 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -124,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "REVDEP-PAX 1" -.TH REVDEP-PAX 1 "2014-07-30" "elfix 0.9" "Documentation for elfix" +.TH REVDEP-PAX 1 "2014-10-13" "elfix 0.9" "Documentation for elfix" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -159,44 +168,35 @@ against it. The library can either be specified by its \s-1SONAME\s0 as it is r by \fBldd\fR(1), or by the full path to the \s-1LIBRARY\s0 file. Symbolic links are dereferenced. The user can optionally scan for all forward mappings on the system (\-f), for all reverse mappings (\-r), for forward mappings of just one -\&\s-1OBJECT\s0 (\-b), for reverse mappings of just one \s-1SONAME\s0 (\-s) or one \s-1LIBRARY\s0 (\-l). +\&\s-1OBJECT \s0(\-b), for reverse mappings of just one \s-1SONAME \s0(\-s) or one \s-1LIBRARY \s0(\-l). In verbose mode (\-v), all mappings are reported, not just mismatching ones, and in mark mode (\-m), the user is prompted whether to proceed with the migration, so that the PaX flags of the target inherit the flags of the source. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-f\fR Scan the system for all forward mappings." 4 -.IX Item "-f Scan the system for all forward mappings." +.IX Item "-f Scan the system for all forward mappings." .PD 0 -.IP "" 4 .IP "\fB\-r\fR Scan the system for all reverse mappings." 4 -.IX Item "-r Scan the system for all reverse mappings." -.IP "" 4 -.IP "\fB\-b\fR \s-1OBJECT\s0 Retrieve only the forward mappings for this \s-1ELF\s0 \s-1OBJECT\s0." 4 -.IX Item "-b OBJECT Retrieve only the forward mappings for this ELF OBJECT." -.IP "" 4 -.IP "\fB\-s\fR \s-1SONAME\s0 Retrieve only the reverse mappings for this \s-1SONAME\s0." 4 -.IX Item "-s SONAME Retrieve only the reverse mappings for this SONAME." -.IP "" 4 -.IP "\fB\-l\fR \s-1LIBRARY\s0 Retrieve only the reverse mappings for this \s-1LIBRARY\s0." 4 -.IX Item "-l LIBRARY Retrieve only the reverse mappings for this LIBRARY." -.IP "" 4 +.IX Item "-r Scan the system for all reverse mappings." +.IP "\fB\-b\fR \s-1OBJECT \s0 Retrieve only the forward mappings for this \s-1ELF OBJECT.\s0" 4 +.IX Item "-b OBJECT Retrieve only the forward mappings for this ELF OBJECT." +.IP "\fB\-s\fR \s-1SONAME \s0 Retrieve only the reverse mappings for this \s-1SONAME.\s0" 4 +.IX Item "-s SONAME Retrieve only the reverse mappings for this SONAME." +.IP "\fB\-l\fR \s-1LIBRARY\s0 Retrieve only the reverse mappings for this \s-1LIBRARY.\s0" 4 +.IX Item "-l LIBRARY Retrieve only the reverse mappings for this LIBRARY." .IP "\fB\-v\fR Report all mappings, not just the mismatched ones." 4 -.IX Item "-v Report all mappings, not just the mismatched ones." -.IP "" 4 +.IX Item "-v Report all mappings, not just the mismatched ones." .ie n .IP "\fB\-e\fR Limit the markings or report to only those executables in the current shell's $PATH." 4 .el .IP "\fB\-e\fR Limit the markings or report to only those executables in the current shell's \f(CW$PATH\fR." 4 -.IX Item "-e Limit the markings or report to only those executables in the current shell's $PATH." -.IP "" 4 +.IX Item "-e Limit the markings or report to only those executables in the current shell's $PATH." .IP "\fB\-m\fR Prompt the user to mark the found object with the PaX flags of the source." 4 -.IX Item "-m Prompt the user to mark the found object with the PaX flags of the source." -.IP "" 4 -.ie n .IP "\fB\-y\fR Assume ""yes"" to all prompts for marking (\s-1USE\s0 \s-1CAREFULLY\s0!)" 4 -.el .IP "\fB\-y\fR Assume ``yes'' to all prompts for marking (\s-1USE\s0 \s-1CAREFULLY\s0!)" 4 -.IX Item "-y Assume yes to all prompts for marking (USE CAREFULLY!)" -.IP "" 4 +.IX Item "-m Prompt the user to mark the found object with the PaX flags of the source." +.ie n .IP "\fB\-y\fR Assume ""yes"" to all prompts for marking (\s-1USE CAREFULLY\s0!)" 4 +.el .IP "\fB\-y\fR Assume ``yes'' to all prompts for marking (\s-1USE CAREFULLY\s0!)" 4 +.IX Item "-y Assume yes to all prompts for marking (USE CAREFULLY!)" .IP "\fB\-h\fR Print out a short help message and exit." 4 -.IX Item "-h Print out a short help message and exit." +.IX Item "-h Print out a short help message and exit." .PD .SH "HOMEPAGE" .IX Header "HOMEPAGE" diff --git a/doc/revdep-pax.pod b/doc/revdep-pax.pod index b1f6d28..45aa567 100644 --- a/doc/revdep-pax.pod +++ b/doc/revdep-pax.pod @@ -42,40 +42,22 @@ so that the PaX flags of the target inherit the flags of the source. =item B<-f> Scan the system for all forward mappings. -=item - =item B<-r> Scan the system for all reverse mappings. -=item - =item B<-b> OBJECT Retrieve only the forward mappings for this ELF OBJECT. -=item - =item B<-s> SONAME Retrieve only the reverse mappings for this SONAME. -=item - =item B<-l> LIBRARY Retrieve only the reverse mappings for this LIBRARY. -=item - =item B<-v> Report all mappings, not just the mismatched ones. -=item - =item B<-e> Limit the markings or report to only those executables in the current shell's $PATH. -=item - =item B<-m> Prompt the user to mark the found object with the PaX flags of the source. -=item - =item B<-y> Assume "yes" to all prompts for marking (USE CAREFULLY!) -=item - =item B<-h> Print out a short help message and exit. =back |