path: root/README
authorSergey Poznyakoff <>2013-03-06 19:07:20 (GMT)
committer Sergey Poznyakoff <>2013-03-06 19:07:20 (GMT)
commite6c64142764eb95e5eaea78db7830b6bffffd7c2 (patch) (side-by-side diff)
tree6720694b76999bd6081163cd0628f4956f59a6bb /README
parent248a97fbf0656d12839ca8986287d216820c9849 (diff)
Improve Makefile, add more docs.HEADmaster
* Makefile: Major cleanup; add rules for distribution targets. * .gitignore: Update. * COPYING: New file. * README: New file.
Diffstat (limited to 'README') (more/less context) (ignore whitespace changes)
1 files changed, 47 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..c149ca1
--- a/dev/null
+++ b/README
@@ -0,0 +1,47 @@
+Copyright (C) 2013 Sergey Poznyakoff
+See the end of file for copying conditions.
+* Overview
+Alck checks one or several sendmail-style alias files for consistency.
+See the accompanying manpage, alck.1, for a detailed description.
+* Building and Configuring
+Run 'make' to build the program. Run 'make install' as a
+superuser to install it. By default, the utility is installed
+in /usr/local/bin. To change the installation directory, use
+the PREFIX make variable. For example, the following command:
+ make install PREFIX=/usr
+will install the binary in /usr/bin and the manpage in
+Specific installation directories can be overridden using the
+following variables:
+ BINDIR the directory where the binary is to be installed
+ MANDIR the directory where the manpage is to be installed
+* Copyright information:
+Copyright (C) 2013 Sergey Poznyakoff
+ Permission is granted to anyone to make or distribute verbatim copies
+ of this document as received, in any medium, provided that the
+ copyright notice and this permission notice are preserved,
+ thus giving the recipient permission to redistribute in turn.
+ Permission is granted to distribute modified versions
+ of this document, or of portions of it,
+ under the above conditions, provided also that they
+ carry prominent notices stating who last changed them.
+Local Variables:
+mode: outline
+paragraph-separate: "[ ]*$"
+version-control: never

Return to:

Send suggestions and report system problems to the System administrator.