comparison INSTALL @ 155:dbe3dadd1afe

Documentation improvements in the INSTALL file and some man pages thanks to Nico R.
author meillo@marmaro.de
date Wed, 14 Jul 2010 12:02:01 +0200
parents 10d00e3235f2
children 949ccc02eecf
comparison
equal deleted inserted replaced
154:4917e764f108 155:dbe3dadd1afe
1 Additional information may be available in docs/ or on the website. 1 Additional information may be available in docs/ or on the website.
2 For installing on GNU/Linux distributions read docs/linux-distris. 2 For installing on GNU/Linux distributions read docs/INSTALL.linux.
3 3
4 4
5 Installation instructions 5 Installation instructions
6 ------------------------- 6 -------------------------
7 7
16 If you use other names than 'mail' and 'trusted' use the options 16 If you use other names than 'mail' and 'trusted' use the options
17 described below for configure. The 42 is just a suggestion, you can 17 described below for configure. The 42 is just a suggestion, you can
18 use any number you like, but preferably one < 100. It does not have 18 use any number you like, but preferably one < 100. It does not have
19 to be the same for the user 'mail' and the group 'trusted'. 19 to be the same for the user 'mail' and the group 'trusted'.
20 20
21 Compliling is a matter of the usual procedure. In the source directory, 21 Compiling is a matter of the usual procedure. In the source directory,
22 after unpacking do: 22 after unpacking do:
23 23
24 ./configure 24 ./configure
25 make 25 make
26 make install 26 make install
52 --with-confdir=CONFDIR sets the default configuration directory to 52 --with-confdir=CONFDIR sets the default configuration directory to
53 CONFDIR, in case you prefer another location than /etc/masqmail/. 53 CONFDIR, in case you prefer another location than /etc/masqmail/.
54 54
55 --enable-auth enables ESMTP AUTH support (disabled by default) 55 --enable-auth enables ESMTP AUTH support (disabled by default)
56 56
57 --disable-pop3 disables pop3 support (enabled by default) 57 --disable-pop3 disables POP3 support (enabled by default)
58 58
59 --enable-maildir enables qmail style Maildir support (disabled by default) 59 --enable-maildir enables qmail style Maildir support (disabled by default)
60 60
61 --enable-ident enable RFC 1413 support. If you have the libident 61 --enable-ident enables RFC 1413 support. If you have the libident
62 dynamic library installed, this will be linked, otherwise it will be 62 dynamic library installed, this will be linked, otherwise it will be
63 statically linked using the sources included in the package. 63 statically linked using the sources included in the package.
64 64
65 --disable-resolver disable resolver support. Without the resolver functions, 65 --disable-resolver disables resolver support. Without the resolver functions,
66 masqmail uses only gethostbyname() to resolve DNS names, and you cannot send 66 masqmail uses only gethostbyname() to resolve DNS names, and you cannot send
67 mail without a smart host. Not recommended. You save 3K at most. 67 mail without a smart host. Not recommended. You save 3K at most.
68 68
69 --disable-smtp-server disable SMTP server support. You may want this if you do 69 --disable-smtp-server disables SMTP server support. You may want this if you do
70 not need masqmail to listen. In this case, you cannot use masqmail as a smart 70 not need masqmail to listen. In this case, you cannot use masqmail as a smart
71 host for other hosts on your LAN, you cannot use mail clients that send SMTP, 71 host for other hosts on your LAN, you cannot use mail clients that send SMTP,
72 you cannot even use pine. In short, use of this option is discouraged unless 72 you cannot even use pine. In short, use of this option is discouraged unless
73 your resources are extremely limited. 73 your resources are extremely limited.
74 74
75 --enable-mserver enable online detection by connecting to the mserver 75 --enable-mserver enables online detection by connecting to the mserver
76 (masqdialer system). 76 (masqdialer system).
77 77
78 --with-libcryto instead of using the md5 and hmac functions within the package, 78 --with-libcryto instead of using the md5 and hmac functions within the package,
79 link dynamically with libcrypto. This applies only if you have pop3 or SMTP 79 link dynamically with libcrypto. This applies only if you have POP3 or SMTP
80 AUTH enabled. Makes only sense if your resources are limited and you have 80 AUTH enabled. Only makes sense if your resources are limited and you have
81 libcrypto installed. Untested. 81 libcrypto installed. Untested.
82 82
83 --with-glib-static link with glib statically. This makes the binary larger 83 --with-glib-static links with glib statically. This makes the binary larger
84 by around 30K (i386 architecture), but if masqmail is the only binary using 84 by around 30K (i386 architecture), but if masqmail is the only binary using
85 glib, you save some space in total, because you do not need the shared glib 85 glib, you save some space in total, because you do not need the shared glib
86 library installed. 86 library installed.
87 87
88 --disable-debug disable debugging, setting it on by command line or configuration 88 --disable-debug disables debugging; enabling it by command line or configuration
89 has no effect. Strongly discouraged, since you miss valuable information if something 89 option has no effect. Strongly discouraged, since you miss valuable information
90 goes wrong. You save 6K. 90 if something goes wrong. You save 6K.
91 91
92 BTW, to get 3K of space, call 92 BTW, to get 3K of space, call
93 strip --remove-section=.comment --remove-section=.note --strip-unneeded src/masqmail 93 strip --remove-section=.comment --remove-section=.note --strip-unneeded src/masqmail
94 after building.
94 95
95 96
96 97
97 after make install: 98 after make install:
98 ------------------- 99 -------------------
101 not want to use it. 102 not want to use it.
102 103
103 Check that 'make install' worked correctly. The following command: 104 Check that 'make install' worked correctly. The following command:
104 105
105 ls -ld /usr/sbin/masqmail /etc/masqmail /var/log/masqmail/ \ 106 ls -ld /usr/sbin/masqmail /etc/masqmail /var/log/masqmail/ \
106 /var/run/masqmail /var/spool/masqmail/ /var/spool/masqmail/* 107 /var/run/masqmail /var/spool/masqmail/ /var/spool/masqmail/*
107 108
108 should give output similar to 109 should give output similar to
109 110
110 -rwsr-xr-x 1 root root 399356 May 10 12:34 /usr/sbin/masqmail 111 -rwsr-xr-x 1 root root 399356 May 10 12:34 /usr/sbin/masqmail
111 drwxr-xr-x 2 root root 4096 May 10 12:34 /etc/masqmail 112 drwxr-xr-x 2 root root 4096 May 10 12:34 /etc/masqmail