[BACK]Return to INSTALL CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/INSTALL between version 1.17 and 1.18

version 1.17, 2016/07/19 22:40:33 version 1.18, 2017/02/08 12:24:10
Line 16  tech@ mailing list, too.
Line 16  tech@ mailing list, too.
   
 Enjoy using the mandoc toolset!  Enjoy using the mandoc toolset!
   
 Ingo Schwarze, Karlsruhe, July 2016  Ingo Schwarze, Karlsruhe, February 2017
   
   
 Installation  Installation
Line 31  Regarding how packages and ports are maintained for yo
Line 31  Regarding how packages and ports are maintained for yo
 system, please consult your operating system documentation.  system, please consult your operating system documentation.
 To install mandoc manually, the following steps are needed:  To install mandoc manually, the following steps are needed:
   
 1. If you want to build the CGI program, man.cgi(8), too, run the  1. If you want to build the CGI program, man.cgi(8), too,
 command "echo BUILD_CGI=1 > configure.local".  Then run "cp  run the command "echo BUILD_CGI=1 >> configure.local".
 cgi.h.examples cgi.h" and edit cgi.h as desired.  Then run "cp cgi.h.example cgi.h" and edit cgi.h as desired.
   
 2. Define MANPATH_DEFAULT in configure.local  2. If you also want to build the new catman(8) utility, run the
   command "echo BUILD_CATMAN=1 >> configure.local".  Note that it
   is unlikely to be a drop-in replacement providing the same
   functionality as your system's "catman", if your operating
   system contains one.
   
   3. Define MANPATH_DEFAULT in configure.local
 if /usr/share/man:/usr/X11R6/man:/usr/local/man is not appropriate  if /usr/share/man:/usr/X11R6/man:/usr/local/man is not appropriate
 for your operating system.  for your operating system.
   
 3. Run "./configure".  4. Run "./configure".
 This script attempts autoconfiguration of mandoc for your system.  This script attempts autoconfiguration of mandoc for your system.
 Read both its standard output and the file "Makefile.local" it  Read both its standard output and the file "Makefile.local" it
 generates.  If anything looks wrong or different from what you  generates.  If anything looks wrong or different from what you
Line 49  result seems right to you.
Line 55  result seems right to you.
 On Solaris 10 and earlier, you may have to run "ksh ./configure"  On Solaris 10 and earlier, you may have to run "ksh ./configure"
 because the native /bin/sh lacks some POSIX features.  because the native /bin/sh lacks some POSIX features.
   
 4. Run "make".  5. Run "make".
 Any POSIX-compatible make, in particular both BSD make and GNU make,  Any POSIX-compatible make, in particular both BSD make and GNU make,
 should work.  If the build fails, look at "configure.local.example"  should work.  If the build fails, look at "configure.local.example"
 and go back to step 2.  and go back to step 2.
   
 5. Run "make -n install" and check whether everything will be  6. Run "make -n install" and check whether everything will be
 installed to the intended places.  Otherwise, put some *DIR or *NM*  installed to the intended places.  Otherwise, put some *DIR or *NM*
 variables into "configure.local" and go back to step 3.  variables into "configure.local" and go back to step 4.
   
 6. Run "sudo make install".  If you intend to build a binary  7. Optionally run the regression suite.
   Basically, that amounts to "cd regress && ./regress.pl".
   But you should probably look at "./mandoc -l regress/regress.pl.1"
   first.
   
   8. Run "sudo make install".  If you intend to build a binary
 package using some kind of fake root mechanism, you may need a  package using some kind of fake root mechanism, you may need a
 command like "make DESTDIR=... install".  Read the *-install targets  command like "make DESTDIR=... install".  Read the *-install targets
 in the "Makefile" to understand how DESTDIR is used.  in the "Makefile" to understand how DESTDIR is used.
   
 7. Run the command "sudo  9. Run the command "sudo makewhatis" to build mandoc.db(5) databases
 makewhatis" to build mandoc.db(5) databases in all the directory  in all the directory trees configured in step 6.  Whenever installing
 trees configured in step 6.  Whenever installing new manual pages,  new manual pages, re-run makewhatis(8) to update the databases, or
 re-run makewhatis(8) to update the databases, or apropos(1) will  apropos(1) will not find the new pages.
 not find the new pages.  
   
 8. To set up a man.cgi(8) server, read its manual page.  10. To set up a man.cgi(8) server, read its manual page.
   
 Note that some man(7) pages may contain low-level roff(7) markup  Note that some man(7) pages may contain low-level roff(7) markup
 that mandoc does not yet understand.  On some BSD systems using  that mandoc does not yet understand.  On some BSD systems using
Line 87  The following libraries are required:
Line 97  The following libraries are required:
   
 2. The fts(3) directory traversion functions.  2. The fts(3) directory traversion functions.
 If your system does not have them, the bundled compatibility version  If your system does not have them, the bundled compatibility version
 will be used, so you need not worry in that case.  But be careful: the  will be used, so you need not worry in that case.  But be careful: old
 glibc version of fts(3) is known to be broken on 32bit platforms,  glibc versions of fts(3) were known to be broken on 32bit platforms,
 see <https://sourceware.org/bugzilla/show_bug.cgi?id=15838>.  see <https://sourceware.org/bugzilla/show_bug.cgi?id=11460>.
   That was presumably fixed in glibc-2.23.
 If you run into that problem, set "HAVE_FTS=0" in configure.local.  If you run into that problem, set "HAVE_FTS=0" in configure.local.
   
 3. Marc Espie's ohash(3) library.  3. Marc Espie's ohash(3) library.

Legend:
Removed from v.1.17  
changed lines
  Added in v.1.18

CVSweb