contrib/mandoc/INSTALL

   1 $Id: INSTALL,v 1.24 2021/09/20 13:25:42 schwarze Exp $
   2
   3 About the portable mandoc distribution
   4 --------------------------------------
   5 The mandoc manpage compiler toolset (formerly called "mdocml")
   6 is a suite of tools compiling mdoc(7), the roff(7) macro language
   7 of choice for BSD manual pages, and man(7), the predominant
   8 historical language for UNIX manuals.
   9
  10 It includes a man(1) manual viewer and additional tools.
  11 For general information, see <http://mandoc.bsd.lv/>.
  12
  13 In case you have questions or want to provide feedback, read
  14 <http://mandoc.bsd.lv/contact.html>.  Consider subscribing to the
  15 discuss@ mailing list mentioned on that page.  If you intend to
  16 help with the development of mandoc, consider subscribing to the
  17 tech@ mailing list, too.
  18
  19 Enjoy using the mandoc toolset!
  20
  21 Ingo Schwarze, Karlsruhe, September 2021
  22
  23
  24 Installation
  25 ------------
  26 Before manually installing mandoc on your system, please check
  27 whether the newest version of mandoc is already installed by default
  28 or available via a binary package or a ports system.  A list of the
  29 latest bundled and ported versions of mandoc for various operating
  30 systems is maintained at <http://mandoc.bsd.lv/ports.html>.
  31
  32 Regarding how packages and ports are maintained for your operating
  33 system, please consult your operating system documentation.
  34 To install mandoc manually, the following steps are needed:
  35
  36 1. If you want to build the CGI program, man.cgi(8), too,
  37 run the command "echo BUILD_CGI=1 >> configure.local".
  38 Then run "cp cgi.h.example cgi.h" and edit cgi.h as desired.
  39
  40 2. If you also want to build the catman(8) utility, run the
  41 command "echo BUILD_CATMAN=1 >> configure.local".  Note that it
  42 is unlikely to be a drop-in replacement providing the same
  43 functionality as your system's "catman", if your operating
  44 system contains one.
  45
  46 3. Define MANPATH_DEFAULT in configure.local
  47 if /usr/share/man:/usr/X11R6/man:/usr/local/man is not appropriate
  48 for your operating system.
  49
  50 4. Run "./configure".
  51 This script attempts autoconfiguration of mandoc for your system.
  52 Read both its standard output and the file "Makefile.local" it
  53 generates.  If anything looks wrong or different from what you
  54 wish, read the file "configure.local.example", create and edit
  55 a file "configure.local", and re-run "./configure" until the
  56 result seems right to you.
  57
  58 5. Run "make".
  59 Any POSIX-compatible make, in particular both BSD make and GNU make,
  60 should work.  If the build fails, look at "configure.local.example"
  61 and go back to step 2.
  62
  63 6. Run "make -n install" and check whether everything will be
  64 installed to the intended places.  Otherwise, put some *DIR or *NM*
  65 variables into "configure.local" and go back to step 4.
  66
  67 7. Optionally run the regression suite.
  68 Basically, that amounts to "make regress" to do a standard regression
  69 run, running all tests.  For more fine-grained control,
  70 read "./mandoc -l regress/regress.pl.1",
  71 then run "cd regress && ./regress.pl" with optional arguments.
  72 The regression suite requires a reasonably modern Perl interpreter.
  73 Examples of systems that are too old to run the regression suite
  74 include Solaris 9, Solaris 10, and Mac OS X 10.4 Tiger.
  75 On Solaris 11, the suite does run, but some tests fail;
  76 look at the BUGS section of that manual page.
  77
  78 8. Run "sudo make install".  If you intend to build a binary
  79 package using some kind of fake root mechanism, you may need a
  80 command like "make DESTDIR=... install".  Read the *-install targets
  81 in the "Makefile" to understand how DESTDIR is used.
  82
  83 9. Run the command "sudo makewhatis" to build mandoc.db(5) databases
  84 in all the directory trees configured in step 3.  Whenever installing
  85 new manual pages, re-run makewhatis(8) to update the databases, or
  86 apropos(1) will not find the new pages.
  87
  88 10. To set up a man.cgi(8) server, read its manual page.
  89
  90 Note that a very small number of man(7) pages contain low-level
  91 roff(7) markup that mandoc does not yet understand.  On some BSD
  92 systems using mandoc, third-party software is vetted on whether it
  93 may be formatted with mandoc.  If not, groff(1) is pulled in as a
  94 dependency and used to install pre-formatted "catpages" instead of
  95 manual page sources.  This mechanism is used much less frequently
  96 than in the past.  On OpenBSD, only 25 out of about 10000 ports
  97 still require formatting with groff(1).
  98
  99
 100 Understanding mandoc dependencies
 101 ---------------------------------
 102 The following libraries are required:
 103
 104 1. zlib for decompressing gzipped manual pages.
 105
 106 2. The fts(3) directory traversion functions.
 107 If your system does not have them, the bundled compatibility version
 108 will be used, so you need not worry in that case.  But be careful: old
 109 glibc versions of fts(3) were known to be broken on 32bit platforms,
 110 see <https://sourceware.org/bugzilla/show_bug.cgi?id=11460>.
 111 That was presumably fixed in glibc-2.23.
 112 If you run into that problem, set "HAVE_FTS=0" in configure.local.
 113
 114 3. Marc Espie's ohash(3) library.
 115 If your system does not have it, the bundled compatibility version
 116 will be used, so you probably need not worry about it.
 117
 118 One of the chief design goals of the mandoc toolbox is to make
 119 sure that nothing related to documentation requires C++.
 120 Consequently, linking mandoc against any kind of C++ program
 121 would defeat the purpose and is not supported.
 122
 123
 124 Checking autoconfiguration quality
 125 ----------------------------------
 126 If you want to check whether automatic configuration works well
 127 on your platform, consider the following:
 128
 129 The mandoc package intentionally does not use GNU autoconf because
 130 we consider that toolset a blatant example of overengineering that
 131 is obsolete nowadays, since all modern operating systems are now
 132 reasonably close to POSIX and do not need arcane shell magic any
 133 longer.  If your system does need such magic, consider upgrading
 134 to reasonably modern POSIX-compliant tools rather than asking for
 135 autoconf-style workarounds.
 136
 137 As far as mandoc is using any features not mandated by ANSI X3.159-1989
 138 ("ANSI C") or IEEE Std 1003.1-2008 ("POSIX") that some modern systems
 139 do not have, we intend to provide autoconfiguration tests and
 140 compat_*.c implementations.  Please report any that turn out to be
 141 missing.  Note that while we do strive to produce portable code,
 142 we do not slavishly restrict ourselves to POSIX-only interfaces.
 143 For improved security and readability, we do use well-designed,
 144 modern interfaces like reallocarray(3) even if they are still rather
 145 uncommon, of course bundling compat_*.c implementations as needed.
 146
 147 Where mandoc is using ANSI C or POSIX features that some systems
 148 still lack and that compat_*.c implementations can be provided for
 149 without too much hassle, we will consider adding them, too, so
 150 please report whatever is missing on your platform.
 151
 152 The following steps can be used to manually check the automatic
 153 configuration on your platform:
 154
 155 1. Run "make distclean".
 156
 157 2. Run "./configure"
 158
 159 3. Read the file "config.log".  It shows the compiler commands used
 160 to test the libraries installed on your system and the standard
 161 output and standard error output these commands produce.  Watch out
 162 for unexpected failures.  Those are most likely to happen if headers
 163 or libraries are installed in unusual places or interfaces defined
 164 in unusual headers.  You can also look at the file "config.h" and
 165 check that no "#define HAVE_*" differ from your expectations.