Mercurial > masqmail
changeset 59:941413084f56
updated docs; moved files around
updated the INSTALL file with content from the old website
moved *agenda* and *ipaq files to docs (are they still relevant?)
| author | meillo@marmaro.de |
|---|---|
| date | Sat, 29 May 2010 22:53:42 +0200 |
| parents | 6ab62592cac4 |
| children | e119cee8d493 |
| files | INSTALL INSTALL.agenda INSTALL.ipaq agenda-config.site docs/INSTALL.agenda docs/INSTALL.ipaq docs/README docs/agenda-config.site docs/linux-distris |
| diffstat | 9 files changed, 269 insertions(+), 164 deletions(-) [+] |
line wrap: on
line diff
--- a/INSTALL Sat May 29 22:33:10 2010 +0200 +++ b/INSTALL Sat May 29 22:53:42 2010 +0200 @@ -1,46 +1,40 @@ -simple installation instructions, see docs/install.html for more. +Additional information may be available in docs/ or on the website. +For installing on GNU/Linux distributions read docs/linux-distris. + -To compile MasqMail you need glib 1.2 (http://www.gtk.org). +Installation instructions +------------------------- + +To compile masqmail you need glib 1.2 (http://www.gtk.org). You need a user and a group for masqmail to run, I suggest user 'mail' and group 'trusted'. Say: -groupadd -g 42 trusted -useradd -u 42 -g 42 -d / -s /bin/sh -c "Mail Transfer Agent" mail + groupadd -g 42 trusted + useradd -u 42 -g 42 -d / -s /bin/sh -c "Mail Transfer Agent" mail If you use other names than 'mail' and 'trusted' use the options described below for configure. The 42 is just a suggestion, you can use any number you like, but preferably one < 100. It does not have to be the same for the user 'mail' and the group 'trusted'. -Then do: - -./configure -make -make install +Compliling is a matter of the usual procedure. In the source directory, +after unpacking do: -Debian: -If you compile for Debian, do the configure with at least these options, -this makes it compatible with the official debian package: -./configure --with-liblockfile --with-group=mail -you do not need the group 'trusted', use 'mail' instead. + ./configure + make + make install -You can also build your own Debian package with -dpkg-buildpackage -rfakeroot -You need to have fakeroot installed to do this. Or, as root, do: -dpkg-buildpackage - -SuSE/Redhat: -There are spec files for rpm creation in suse/ or redhat/. You may have to adjust these files. -Sorry, but after that you are not yet finished. For instruction on how -to deliver mail using a connection to your ISP see -docs/install.html. It is probably a good idea to copy the files -docs/*.html to a directory where you can access them with a browser. +Additional options for configure +-------------------------------- -additional options for configure: ---------------------------------- +See the output of + + ./configure -h + +Here is additional, but maybe obsolete, explanation: --with-user=USER sets the user as which MasqMail will run. Default is 'mail'. USER has to exist before you 'make install'. @@ -98,6 +92,8 @@ BTW, to get 3K of space, call strip --remove-section=.comment --remove-section=.note --strip-unneeded src/masqmail + + after make install: ------------------- @@ -106,30 +102,95 @@ Check that 'make install' worked correctly. The following command: -ls -ld /usr/sbin/masqmail /var/masqmail/ /var/spool/masqmail /var/spool/masqmail/input + ls -ld /usr/sbin/masqmail /etc/masqmail /var/log/masqmail/ \ + /var/run/masqmail /var/spool/masqmail/ /var/spool/masqmail/* should give output similar to --rwsr-xr-x 1 root root 86955 Oct 14 14:27 /usr/sbin/masqmail -drwxr-xr-x 2 mail trusted 1024 Oct 14 14:29 /var/masqmail/ -drwxr-xr-x 3 mail trusted 1024 Oct 14 14:27 /var/spool/masqmail -drwxr-xr-x 2 mail trusted 1024 Oct 14 18:32 /var/spool/masqmail/input -drwxr-xr-x 2 mail trusted 1024 Oct 14 18:32 /var/spool/masqmail/lock -drwxr-xr-x 2 mail trusted 1024 Oct 14 18:32 /var/spool/masqmail/popuidl + -rwsr-xr-x 1 root root 399356 May 10 12:34 /usr/sbin/masqmail + drwxr-xr-x 2 root root 4096 May 10 12:34 /etc/masqmail + drwxr-xr-x 2 mail trusted 4096 May 10 12:34 /var/log/masqmail + drwxr-xr-x 2 mail trusted 4096 May 10 12:34 /var/run/masqmail + drwxr-xr-x 5 mail trusted 4096 May 10 12:34 /var/spool/masqmail + drwxr-xr-x 2 mail trusted 4096 May 10 12:34 /var/spool/masqmail/input + drwxr-xr-x 2 mail trusted 4096 May 10 12:34 /var/spool/masqmail/lock + drwxr-xr-x 2 mail trusted 4096 May 10 12:34 /var/spool/masqmail/popuidl (important is the set-user-id bit for /usr/sbin/masqmail and the ownership of all items). Use the example configuration files in examples/ to edit your own. The -main configuration should go to /etc/masqmail.conf. I recommend to -make a directory /etc/masqmail for the *.route amd *.get files. +main configuration file `masqmail.conf' and the *.route and *.get files +should go into /etc/masqmail. -The default destination for the executable 'masqmail' is -/usr/sbin. Check that it has the set user id bit set. (chmod u+s -/usr/sbin/masqmail does no harm in any case). +The default destination for the executable `masqmail' is /usr/sbin. +Check that it has the set-uid bit set. You can set it with: + + chmod u+s /usr/sbin/masqmail If you want to replace sendmail, move your old sendmail binary to -another name and make a symbolic link /usr/sbin/sendmail -> -/usr/sbin/masqmail. +another name and make a symbolic link: + + ln -s /usr/sbin/masqmail /usr/sbin/sendmail + +Now every mailer that used to call sendmail will now call masqmail. You +can now kill your old sendmail if it is running and start masqmail. + + /sbin/init.d/sendmail restart + +should do that. You can also start masqmail with: + + /usr/sbin/masqmail -bd -q30m + +Configuring for online delivery +------------------------------- + +(This section covers dial-up internet connections.) + +Now you have to set up the online configuration. The trick is to tell +your ip-up script the connection name. You could use the IP number of +the far side of the ppp link, but this is a pain and may change each +time. But you can give it an additional argument via pppd with ipparam. +Somewhere in your dial up script you have a line similar to: + + /usr/sbin/pppd /dev/ttyS1 connect "/usr/sbin/chat -t 90 -f $CHATFILE" \ + -d -d -d user user@somewhere file "$OPTIONS" + +Just add 'ipparam FastNet' in the command line for pppd if your ISP has +the name FastNet. The ip-up script will then get 'FastNet' as a sixth +parameter. In your ip-up script you can then call masqmail with + + /usr/sbin/masqmail -qo "$6" + +instead of 'sendmail -q', if you had that in the script before. +Masqmail will then read the route configuration specified for the +connection name 'FastNet' and deliver the mail destined to the internet. +See the configuration manual on how to write a route configuration or +use one of the examples as a template. + +I do not know how do configure that for an ISDN adapter, but I am sure +you will find something similar in the man pages. + +If you want mail that is received by masqmail from your local net to be +delivered immediately using the route configuration, you have two +possibilities: + +* if you are using the masqdialer system, you just have to set the + variables online_detect to mserver and mserver_iface to the interface + mserver is listening to. +* otherwise you have to add two commands in your ip-up script: + echo -n $6 > /tmp/connect_route + chmod 644 /tmp/connect_route + and you have to remove the file /tmp/connect_route in your ip-down script: + rm /tmp/connect_route. + Then you have to set online_detect to file and online_file to + /tmp/connect_route. + +See the route documentation for more. + + + +Written by oku. +Updated by meillo.
--- a/INSTALL.agenda Sat May 29 22:33:10 2010 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,37 +0,0 @@ - -prerequesites: --------------- -cp /usr/lib/glib-config /usr/mipsel-linux/bin -and apply this patch: - -3c3 -< prefix=/usr ---- -> prefix=/usr/mipsel-linux/ - - -compile -------- -export CONFIG_SITE=./agenda-config.site - -./configure --prefix=/usr/local/ --with-spooldir=/flash/spool/masqmail/ --with-glib-prefix=/usr/mipsel-linux/ --disable-smtp-server --disable-resolver --with-group=mail --disable-debug --enable-auth -make - -mipsel-linux-strip --remove-section=.comment --remove-section=.note --strip-unneeded src/masqmail - -install -------- - -# Become root and do: -make DESTDIR=/tmp/agenda-masqmail/ install - -# make the configuration directory writable for user mail -# (this is needed for sqilconf) -chown mail.mail /tmp/agenda-masqmail/etc/masqmail/ -chmod g+rw /tmp/agenda-masqmail/etc/masqmail/ - -# delete man pages and unneeded binaries: -rm -rf /tmp/agenda-masqmail/usr/local/man/ /tmp/agenda-masqmail/usr/local/bin/ - -You can now rsync the files you need to your agenda from DESTDIR. -
--- a/INSTALL.ipaq Sat May 29 22:33:10 2010 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -For a cross compiler: - -Download ipaq-config.site from http://masqmail.cx/ipaq/cross/. There -are also some more instructions. - -export CONFIG_SITE=./ipaq-config.site - -./configure --with-glib-prefix=/skiff/local/ \ - --disable-smtp-server --disable-resolver \ - --with-group=mail --disable-debug --enable-auth -make - -su -make DESTDIR=/tmp/masqmail install -
--- a/agenda-config.site Sat May 29 22:33:10 2010 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,71 +0,0 @@ -# config.site for configure -# Agenda Vr3 TARGET - -# You could put this file to /usr/local/mipsel-linux/etc/agenda-config.site - -# run with -# CONFIG_SITE=/wherever/you/store/it/agenda-config.site ./configure -# or -# export CONFIG_SITE=/wherever/you/store/it/agenda-config.site -# if this is going to be a whole compilation orgy - -# Modified from the one provided by Bradley D. LaRonde - -# Edited by Andrej Cedilnik <acedil1@csee.umbc.edu> - -# Used some of solutions by Tilman Vogel <Tilman.Vogel@web.de> - -HOSTCC=gcc - -# Names of the cross-compilers -CC=mipsel-linux-gcc -CXX=mipsel-linux-gcc - -# The cross compiler specific options -CFLAGS="-s -mips2 -O2 -fno-exceptions" -CXXFLAGS="-s -mips2 -O2 -fno-exceptions -I/usr/mipsel-linux/include/g++" -CPPFLAGS="-s -mips2 -O2 -fno-exceptions -I/usr/mipsel-linux/include/g++" -LDFLAGS="-s -mips2" - -# Some other programs -AR=mipsel-linux-ar -RANLIB=mipsel-linux-ranlib -NM=mipsel-linux-nm -ac_cv_path_NM=mipsel-linux-nm -ac_cv_func_setpgrp_void=yes -host=mipsel-linux -#prefix=/usr/mipsel-linux -x_includes=/usr/mipsel-linux/include -x_libraries=/usr/mipsel-linux/X11R6/lib - -# These are for GNU shellutils -jm_cv_have_proc_uptime=yes -jm_cv_func_working_gnu_strftime=yes - -# Some options for ease of compiling python -ac_cv_sizeof_int=4 -ac_cv_sizeof_char=1 -ac_cv_sizeof_short=2 -ac_cv_sizeof_float=4 -ac_cv_sizeof_double=8 -ac_cv_sizeof_pthread_t=4 -ac_cv_sizeof_long=4 -ac_cv_sizeof_void_p=4 -ac_cv_sizeof_long_long=8 -ac_cv_sizeof_off_t=4 -ac_cv_sizeof_fpos_t=4 -ac_cv_sizeof_time_t=4 - -# Some other stuff nobody knows why -bad_forward=no -LDSHARED='mipsel-linux-gcc -msoft-float -shared' -ac_cv_malloc_zero=nonnull - -# squeak wants this -# can't do misaligned access to doubles -ac_cv_double_align=no -# dunno what order doubles are in -ac_cv_double_order=no - -ac_cv_header_wchar_h=no -
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/INSTALL.agenda Sat May 29 22:53:42 2010 +0200 @@ -0,0 +1,37 @@ + +prerequesites: +-------------- +cp /usr/lib/glib-config /usr/mipsel-linux/bin +and apply this patch: + +3c3 +< prefix=/usr +--- +> prefix=/usr/mipsel-linux/ + + +compile +------- +export CONFIG_SITE=./agenda-config.site + +./configure --prefix=/usr/local/ --with-spooldir=/flash/spool/masqmail/ --with-glib-prefix=/usr/mipsel-linux/ --disable-smtp-server --disable-resolver --with-group=mail --disable-debug --enable-auth +make + +mipsel-linux-strip --remove-section=.comment --remove-section=.note --strip-unneeded src/masqmail + +install +------- + +# Become root and do: +make DESTDIR=/tmp/agenda-masqmail/ install + +# make the configuration directory writable for user mail +# (this is needed for sqilconf) +chown mail.mail /tmp/agenda-masqmail/etc/masqmail/ +chmod g+rw /tmp/agenda-masqmail/etc/masqmail/ + +# delete man pages and unneeded binaries: +rm -rf /tmp/agenda-masqmail/usr/local/man/ /tmp/agenda-masqmail/usr/local/bin/ + +You can now rsync the files you need to your agenda from DESTDIR. +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/INSTALL.ipaq Sat May 29 22:53:42 2010 +0200 @@ -0,0 +1,15 @@ +For a cross compiler: + +Download ipaq-config.site from http://masqmail.cx/ipaq/cross/. There +are also some more instructions. + +export CONFIG_SITE=./ipaq-config.site + +./configure --with-glib-prefix=/skiff/local/ \ + --disable-smtp-server --disable-resolver \ + --with-group=mail --disable-debug --enable-auth +make + +su +make DESTDIR=/tmp/masqmail install +
--- a/docs/README Sat May 29 22:33:10 2010 +0200 +++ b/docs/README Sat May 29 22:53:42 2010 +0200 @@ -1,2 +1,12 @@ Since masqmail-0.2.22, documentation is maintained in troff (man page) format directly. The old XML sources are no longer used. + +The `old-manual' directory contains the old manual (as expected) and +html versions of man pages from that time (May/July 2000). The files +have been copied from the old project website. + +There are installation instructions for various systems available. Some +of them are outdated and may not work anymore. + + +meillo
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/agenda-config.site Sat May 29 22:53:42 2010 +0200 @@ -0,0 +1,71 @@ +# config.site for configure +# Agenda Vr3 TARGET + +# You could put this file to /usr/local/mipsel-linux/etc/agenda-config.site + +# run with +# CONFIG_SITE=/wherever/you/store/it/agenda-config.site ./configure +# or +# export CONFIG_SITE=/wherever/you/store/it/agenda-config.site +# if this is going to be a whole compilation orgy + +# Modified from the one provided by Bradley D. LaRonde + +# Edited by Andrej Cedilnik <acedil1@csee.umbc.edu> + +# Used some of solutions by Tilman Vogel <Tilman.Vogel@web.de> + +HOSTCC=gcc + +# Names of the cross-compilers +CC=mipsel-linux-gcc +CXX=mipsel-linux-gcc + +# The cross compiler specific options +CFLAGS="-s -mips2 -O2 -fno-exceptions" +CXXFLAGS="-s -mips2 -O2 -fno-exceptions -I/usr/mipsel-linux/include/g++" +CPPFLAGS="-s -mips2 -O2 -fno-exceptions -I/usr/mipsel-linux/include/g++" +LDFLAGS="-s -mips2" + +# Some other programs +AR=mipsel-linux-ar +RANLIB=mipsel-linux-ranlib +NM=mipsel-linux-nm +ac_cv_path_NM=mipsel-linux-nm +ac_cv_func_setpgrp_void=yes +host=mipsel-linux +#prefix=/usr/mipsel-linux +x_includes=/usr/mipsel-linux/include +x_libraries=/usr/mipsel-linux/X11R6/lib + +# These are for GNU shellutils +jm_cv_have_proc_uptime=yes +jm_cv_func_working_gnu_strftime=yes + +# Some options for ease of compiling python +ac_cv_sizeof_int=4 +ac_cv_sizeof_char=1 +ac_cv_sizeof_short=2 +ac_cv_sizeof_float=4 +ac_cv_sizeof_double=8 +ac_cv_sizeof_pthread_t=4 +ac_cv_sizeof_long=4 +ac_cv_sizeof_void_p=4 +ac_cv_sizeof_long_long=8 +ac_cv_sizeof_off_t=4 +ac_cv_sizeof_fpos_t=4 +ac_cv_sizeof_time_t=4 + +# Some other stuff nobody knows why +bad_forward=no +LDSHARED='mipsel-linux-gcc -msoft-float -shared' +ac_cv_malloc_zero=nonnull + +# squeak wants this +# can't do misaligned access to doubles +ac_cv_double_align=no +# dunno what order doubles are in +ac_cv_double_order=no + +ac_cv_header_wchar_h=no +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/linux-distris Sat May 29 22:53:42 2010 +0200 @@ -0,0 +1,34 @@ +Distribution specific stuff +=========================== + +Debian +------ + +If you compile for Debian, do the configure with at least these options: + + ./configure --with-liblockfile --with-group=mail + +Use the group `mail' instead of the group `trusted'. + +You can also build your own Debian package with + + dpkg-buildpackage -rfakeroot + +You need to have fakeroot installed to do this. Or, as root, do: + + dpkg-buildpackage + +However, you better have a look at the official masqmail package in +Debian. + + apt-get source masqmail + +is your friend. + + + +SuSE/Redhat +----------- + +There are spec files for rpm creation on the website. You may have to +adjust these files.