Better handling of libtool commands.

[blhc/blhc.git] / README

diff --git a/README b/README
index 08b6879401ddd67b2c8abf9261d220c7b1ee9e0b..aeccd300db8c5cc61487846b242692fa17ef8ccd 100644 (file)
--- a/README
+++ b/README
@@ -13,12 +13,16 @@ all compiler commands use the correct hardening flags and thus all hardening
 features are correctly used.
 
 It's designed to check build logs generated by Debian's dpkg-buildpackage (or
 features are correctly used.
 
 It's designed to check build logs generated by Debian's dpkg-buildpackage (or

-tools using dpkg-buildpackage like pbuilder or the official buildd build logs)
-to help maintainers detect missing hardening flags in their packages.
+tools using dpkg-buildpackage like pbuilder or sbuild (which is used for the
+official buildd build logs)) to help maintainers detect missing hardening
+flags in their packages.

 
 At the moment it works only on Debian and derivatives but it should be easily
 extendable to other systems as well. Patches are welcome.
 
 
 At the moment it works only on Debian and derivatives but it should be easily
 extendable to other systems as well. Patches are welcome.
 

+Only gcc is detected as compiler at the moment. If other compilers support
+hardening flags as well, please report them.
+

 For more information about hardening flags have a look at [1].
 
 [1]: https://wiki.debian.org/Hardening
 For more information about hardening flags have a look at [1].
 
 [1]: https://wiki.debian.org/Hardening


@@ -30,6 +34,10 @@ DEPENDENCIES
 - Perl
   - Dpkg::Arch
   - Dpkg::Version
 - Perl
   - Dpkg::Arch
   - Dpkg::Version

+  - Term::ANSIColor >= 2.01
+    Bundled with perl. A recent version is only necessary for build logs with
+    ANSI colors which is rare, blhc works fine without if the build log
+    doesn't use colors. Not required for buildd mode.

 
 
 USAGE
 
 
 USAGE


@@ -37,6 +45,12 @@ USAGE
 
     blhc path/to/log/file
 
 
     blhc path/to/log/file
 

+blhc can be run directly from the source tree (`bin/blhc`) or copied anywhere
+on the system. It doesn't have to be explicitly installed. To read the man
+page use `perldoc bin/blhc`.
+
+If there's no output, no flags are missing and the build log is fine.
+

 For more examples see the man page.
 
 
 For more examples see the man page.
 
 


@@ -87,6 +101,15 @@ following line (output of dpkg-buildpackage):
 The available hardening flags are adapted to the architecture because some
 architectures don't support certain hardening options.
 
 The available hardening flags are adapted to the architecture because some
 architectures don't support certain hardening options.
 

+Some checks check the build dependencies for certain packages. The following
+lines are used to get the build dependencies. The first two are used in buildd
+build logs (the second was used in older logs), the third by pbuilder logs,
+all are detected:
+
+    Filtered Buildd-Depends: ...
+    Build-Depends: ...
+    Depends: ...
+

 
 LIMITATIONS
 -----------
 
 LIMITATIONS
 -----------


@@ -97,7 +120,7 @@ real compile process (output of dpkg-buildpackage):
     dpkg-buildpackage: ...
 
 If it's not present no compiler commands are detected. In case you don't use
     dpkg-buildpackage: ...
 
 If it's not present no compiler commands are detected. In case you don't use

-dpkp-buildpackage but still want to check a build log adding it as first line
+dpkp-buildpackage but still want to check a build log, adding it as first line

 should work fine.
 
 The following non-verbose builds can't be detected:
 should work fine.
 
 The following non-verbose builds can't be detected:


@@ -147,7 +170,7 @@ LICENSE
 
 blhc is licensed under GPL version 3 or later.
 
 
 blhc is licensed under GPL version 3 or later.
 

-Copyright (C) 2012  Simon Ruderich
+Copyright (C) 2012-2013  Simon Ruderich

 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by