sdl2man

converts SDL Wiki pages to manpages
git clone git://nihaljere.xyz/sdl2man
Log | Files | Refs | README

README.md (1197B)


      1 ### sdl2man
      2 
      3 This utility converts SDLWiki pages to manpages. Using the RecentChanges page on the SDLWiki, it can also figure out which wiki pages have been updated, and update the man pages accordingly.
      4 
      5 Currently it works well for many pages but not so well for others. I plan to continue to develop this while using it, but pull requests are always welcome.
      6 
      7 The script requires the requests library.
      8 
      9     usage: sdl2man [-h] [-p | -f] [-t TIME_INTERVAL] [-g] [-i]
     10 
     11     optional arguments:
     12       -h, --help            show this help message and exit
     13       -p, --pull            downloads updated copies of changed pages
     14       -f, --fresh           removes local copies of pages and redownloads
     15       -t TIME_INTERVAL, --time-interval TIME_INTERVAL
     16                             sets time interval on page downloads in seconds (to
     17                             avoid rate limiting), default is 10
     18       -g, --generate        generates manpages from local copies
     19 
     20     The generated man pages will be located at $XDG_DATA_HOME/sdl2man/man (usually
     21     .local/share/sdl2man/man). They can be installed by running the script in the
     22     sdl2man directory, or by adding the man directory to your MANPATH.