scdoc2mdoc

A fork of scdoc to output mdoc(7)
git clone git://git.sgregoratto.me/scdoc2mdoc
Log | Files | Refs | README | LICENSE

README.md (735B)


      1 # scdoc2mdoc
      2 
      3 scdoc2mdoc is a man page generator for POSIX systems written in C99.
      4 It is a fork of the original [scdoc] that outputs `[mdoc(7)]` syntax.
      5 
      6 ## Installation
      7 
      8 Before building, run the configure script
      9 (a modified version of [oconfigure]).
     10 
     11 ```sh
     12 ./configure
     13 # Or, to set make variables
     14 CC="clang" CFLAGS="-g" ./configure PREFIX=/usr
     15 make
     16 sudo make DESTDIR=/path/to/destination install
     17 ```
     18 
     19 ## Usage
     20 
     21 See scdoc(1), scdoc(5)
     22 
     23 ## Contributing
     24 
     25 Send patches/bug reports to [~toasterking/public-inbox@lists.sr.ht][mailing-list]
     26 
     27 [mailing-list]: mailto:~toasterking/public-inbox@lists.sr.ht
     28 [scdoc]: https://git.sr.ht/~sircmpwn/scdoc
     29 [mdoc]:  https://man.openbsd.org/mdoc.7
     30 [oconfigure]: https://github.com/kristapsdz/oconfigure