1 |
commit: 2f8d27e7f8afbe29b47a6c5617f6ef915443bc28 |
2 |
Author: Mike Frysinger <vapier <AT> gentoo <DOT> org> |
3 |
AuthorDate: Sat Dec 19 19:20:43 2015 +0000 |
4 |
Commit: Mike Frysinger <vapier <AT> gentoo <DOT> org> |
5 |
CommitDate: Sat Dec 19 19:20:43 2015 +0000 |
6 |
URL: https://gitweb.gentoo.org/proj/pax-utils.git/commit/?id=2f8d27e7 |
7 |
|
8 |
README: convert to markdown |
9 |
|
10 |
It's still human readable, but also renders better on systems like github. |
11 |
|
12 |
README | 60 ------------------------------------------------ |
13 |
README.md | 78 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
14 |
2 files changed, 78 insertions(+), 60 deletions(-) |
15 |
|
16 |
diff --git a/README b/README |
17 |
deleted file mode 100644 |
18 |
index 4026140..0000000 |
19 |
--- a/README |
20 |
+++ /dev/null |
21 |
@@ -1,60 +0,0 @@ |
22 |
-HOMEPAGE: https://wiki.gentoo.org/wiki/Hardened/PaX_Utilities |
23 |
-GIT: git clone git://anongit.gentoo.org/proj/pax-utils.git |
24 |
-VIEWVCS: https://gitweb.gentoo.org/proj/pax-utils.git/ |
25 |
- |
26 |
-pax-utils is a small set of various PaX aware and related utilities for |
27 |
-ELF binaries. It was written for ELF Q/A on Gentoo systems but can be |
28 |
-used on any distro. |
29 |
- |
30 |
-Note: to rebuild the man-pages, you will need xmlto and the docbook-xml-dtd |
31 |
- packages installed on your system. |
32 |
- |
33 |
-== INSTALL == |
34 |
- |
35 |
-make install |
36 |
- |
37 |
-You don't need PaX to use the pax-utils. Infact the only thing they |
38 |
-really have in common is that pax-utils was initially written to aid in |
39 |
-deploying PaX systems so it includes support for PT_PAX_FLAGS and the |
40 |
-deprecated but still in use EI_PAX flags. For more information about PaX |
41 |
-see the homepage at http://pax.grsecurity.net/ |
42 |
- |
43 |
-== LINKS == |
44 |
- |
45 |
-(Gentoo) |
46 |
-https://wiki.gentoo.org/wiki/Hardened/PaX_Utilities |
47 |
-https://gitweb.gentoo.org/proj/pax-utils.git/ |
48 |
-Maintainer: solar@g.o,vapier@g.o |
49 |
- |
50 |
-(openSUSE) |
51 |
-https://build.opensuse.org/package/show?package=pax-utils&project=openSUSE%3AFactory |
52 |
-Maintainer: ludwig.nussel@××××.de |
53 |
- |
54 |
-(Ubuntu) |
55 |
-http://packages.ubuntu.com/edgy/devel/pax-utils |
56 |
-Maintainer: john.r.moser@×××××.com |
57 |
- |
58 |
-(Debian) |
59 |
-http://packages.debian.org/unstable/misc/pax-utils |
60 |
-http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=388200 |
61 |
-Maintainer: rdenis@××××××××××××.com |
62 |
- |
63 |
-(FreeBSD) |
64 |
-http://portsmon.freebsd.org/portoverview.py?category=sysutils&portname=pax-utils |
65 |
-http://www.freshports.org/sysutils/pax-utils/ |
66 |
-http://archive.netbsd.se/?ml=freebsd-cvs-all&a=2006-08&m=2311441 |
67 |
-Maintainer: sbz@×××××××.org |
68 |
- |
69 |
-(OpenEmedded) |
70 |
-http://www.openembedded.org/filebrowser/org.openembedded.dev/packages/pax-utils |
71 |
- |
72 |
-(Crux) |
73 |
-http://magog.se/crux/pax-utils/Pkgfile |
74 |
-Maintainer: mattias@×××××××××.se |
75 |
- |
76 |
-(Fedora) |
77 |
-https://apps.fedoraproject.org/packages/pax-utils |
78 |
-Maintainer: Dominik 'Rathann' Mierzejewski <rpm@××××××××××.net> |
79 |
- |
80 |
-(ArchLinux?) |
81 |
- |
82 |
|
83 |
diff --git a/README.md b/README.md |
84 |
new file mode 100644 |
85 |
index 0000000..4913455 |
86 |
--- /dev/null |
87 |
+++ b/README.md |
88 |
@@ -0,0 +1,78 @@ |
89 |
+# ELF/PaX Utilities |
90 |
+ |
91 |
+| What | How | |
92 |
+| -------- | ----------------------------------------------------- | |
93 |
+| HOMEPAGE | https://wiki.gentoo.org/wiki/Hardened/PaX_Utilities | |
94 |
+| GIT | git clone git://anongit.gentoo.org/proj/pax-utils.git | |
95 |
+| VIEWVCS | https://gitweb.gentoo.org/proj/pax-utils.git/ | |
96 |
+| STATUS | [![Build Status](https://travis-ci.org/gentoo/pax-utils.svg?branch=master)](https://travis-ci.org/gentoo/pax-utils) | |
97 |
+ |
98 |
+pax-utils is a small set of utilities for peforming Q/A (mostly security) |
99 |
+checks on systems (most notably, `scanelf`). It is focused on the ELF |
100 |
+format, but does include a Mach-O helper too for OS X systems. |
101 |
+ |
102 |
+While heavily integrated into Gentoo's build system, it can be used on any |
103 |
+distro as it is a generic toolset. |
104 |
+ |
105 |
+Originally focused only on [PaX](https://pax.grsecurity.net/), it has been |
106 |
+expanded to be generally security focused. It still has a good number of |
107 |
+PaX helpers for people interested in that. |
108 |
+ |
109 |
+## Building |
110 |
+ |
111 |
+Just run `make`. This should work on any recent POSIX compliant system. |
112 |
+ |
113 |
+Note: To rebuild the man-pages, you will need xmlto and the docbook-xml-dtd |
114 |
+ packages installed on your system. |
115 |
+ |
116 |
+## Installation |
117 |
+ |
118 |
+`make install` |
119 |
+ |
120 |
+You don't need PaX to use the pax-utils. Infact the only thing they |
121 |
+really have in common is that pax-utils was initially written to aid in |
122 |
+deploying PaX systems so it includes support for PT_PAX_FLAGS and the |
123 |
+deprecated but still in use EI_PAX flags. For more information about PaX |
124 |
+see the homepage at http://pax.grsecurity.net/ |
125 |
+ |
126 |
+## Links |
127 |
+ |
128 |
+If you include pax-utils in your distro, feel free to send an update for this. |
129 |
+ |
130 |
+##### Gentoo |
131 |
+ * https://wiki.gentoo.org/wiki/Hardened/PaX_Utilities |
132 |
+ * https://gitweb.gentoo.org/proj/pax-utils.git/ |
133 |
+ * Maintainer: Mike Frysinger <vapier@g.o>, Ned Ludd <solar@g.o> |
134 |
+ |
135 |
+##### openSUSE |
136 |
+ * https://build.opensuse.org/package/show?package=pax-utils&project=openSUSE%3AFactory |
137 |
+ * Maintainer: ludwig.nussel@××××.de |
138 |
+ |
139 |
+##### Ubuntu |
140 |
+ * http://packages.ubuntu.com/edgy/devel/pax-utils |
141 |
+ * Maintainer: john.r.moser@×××××.com |
142 |
+ |
143 |
+##### Debian |
144 |
+ * http://packages.debian.org/unstable/misc/pax-utils |
145 |
+ * http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=388200 |
146 |
+ * Maintainer: rdenis@××××××××××××.com |
147 |
+ |
148 |
+##### FreeBSD |
149 |
+ * http://portsmon.freebsd.org/portoverview.py?category=sysutils&portname=pax-utils |
150 |
+ * http://www.freshports.org/sysutils/pax-utils/ |
151 |
+ * http://archive.netbsd.se/?ml=freebsd-cvs-all&a=2006-08&m=2311441 |
152 |
+ * Maintainer: sbz@×××××××.org |
153 |
+ |
154 |
+##### OpenEmedded |
155 |
+ * http://www.openembedded.org/filebrowser/org.openembedded.dev/packages/pax-utils |
156 |
+ |
157 |
+##### Crux |
158 |
+ * http://magog.se/crux/pax-utils/Pkgfile |
159 |
+ * Maintainer: mattias@×××××××××.se |
160 |
+ |
161 |
+##### Fedora |
162 |
+ * https://apps.fedoraproject.org/packages/pax-utils |
163 |
+ * Maintainer: Dominik 'Rathann' Mierzejewski <rpm@××××××××××.net> |
164 |
+ |
165 |
+##### ArchLinux |
166 |
+ * https://www.archlinux.org/packages/community/x86_64/pax-utils/ |