summaryrefslogtreecommitdiffhomepage
path: root/docs/man8
AgeCommit message (Collapse)Author
2020-09-06manpages: update copyright yearsrofl0r
2020-09-06update documentation about signalsrofl0r
2020-08-19generate manpages with pod2man instead of a2x/asciidoc(tor)rofl0r
it turned out that the upstream section in tinyproxy.conf.5 wasn't rendered properly, because in asciidoc items following a list item are always explicitly appended to the last list item. after several hours of finding a workaround, it was decided to change the manpage generator to pod2man instead. as pod2man ships together with any perl base install, it should be available on almost every UNIX system, unlike asciidoc which requires installation of a huge set of dependencies (more than 1.3 GB on Ubuntu 16.04), and the replacement asciidoctor requires a ruby installation plus a "gem" (which is by far better than asciidoc, but still more effort than using the already available pod2man). tinyproxy's hard requirement of a2x (asciidoctor) for building from source caused rivers of tears (and dozens of support emails/issues) in the past, but finally we get rid of it. a tool such as a2x with its XML based bloat- technology isn't really suited to go along with a supposedly lightweight C program. if it ever turns out that even pod2man is too heavy a dependency, we could still write our own replacement in less than 50 lines of awk, as the pod syntax is very low level and easy to parse.
2020-08-12add configure option to disable manpage generationrofl0r
using --disable-manpage-support it's finally possibly to disable the formerly obligatory use of a2x to generate the manpage documentation. this is the final solution to the decade old problem that users need to install the enormous asciidoc package to compile TINYproxy from source, or otherwise get a build error, even though the vast majority is only interested in the program itself. solution was inspired by PR #179. closes #179 closes #111 note that since 1.10.0 release the generated release tarball includes the generated manpages too; in which case neither the use of a2x nor --disable-manpage-support is required.
2020-08-11move manpages to maintainer-clean make targetrofl0r
according to https://www.gnu.org/prep/standards/html_node/Standard-Targets.html#Standard-Targets `maintainer-clean` is the proper make target for files that are distributed in a release tarball: > The ‘maintainer-clean’ target is intended to be used by a maintainer of the > package, not by ordinary users. > You may need special tools to reconstruct some of the files that > ‘make maintainer-clean’ deletes. this prevents users without a2x or asciidoctor from losing their ability to recompile tinyproxy after `make clean`, but it also means that users wanting to regenerate the documentation need to run `make maintainer-clean`.
2020-08-11add support for asciidoctor to generate manpagesrofl0r
asciidoctor is a modern replacement for asciidoc and much more lightweight, issuing "apt-get install asciidoc" on ubuntu 16.04 results in an attempt to install more than 1.3 GB of dependencies.
2018-09-05tinyproxy.8: remove l flag from short optionsrofl0r
2018-09-01docs: update the copyright notice in the manpagesMichael Adam
Signed-off-by: Michael Adam <obnox@samba.org>
2018-09-01main: remove the "-l" switch to display the license and authorsMichael Adam
Signed-off-by: Michael Adam <obnox@samba.org>
2017-01-04Merge pull request #59 from gmp216/pullMichael Adam
Fix OS X build
2017-01-04Added conditional for xmllint by testing "a2x" without the -L flag.Greg
2016-12-20ship manpages as part of the dist tarballrofl0r
`make dist` now creates the manpages and puts them into the tarball, so the user does not need to have `a2x` installed to build them. closes #2
2016-01-03update URLrofl0r
2011-08-16Minor whitespace fixMukund Sivaraman
2010-04-22Use complete sentences in the manpagesMukund Sivaraman
2010-03-28Just fix the support URLsMukund Sivaraman
2010-03-28Revert "Update Tinyproxy website URLs"Mukund Sivaraman
This reverts commit b108162dfb408b4818a6ea8b2a148ddaf1506bbe.
2010-03-27Update Tinyproxy website URLsMukund Sivaraman
2010-03-02change the default pid file location to ↵Michael Adam
"@LOCALSTATEDIR@/run/tinyproxy/tinyproxy.pid" I.e., add a tinyproxy subdirectory. This is meant to ease running tinyproxy as non-root user. The subdirectory can be used to give the tinyproxy user write permission. Michael
2010-03-02change the default log file location to ↵Michael Adam
"@LOCALSTATEDIR@/log/tinyproxy/tinyproxy.log" i.e. add a tinyproxy subdirectory. This is meant to ease running tinyproxy as non-root user the subdirectory can be used to give the tinyproxy user write permission. Michael
2010-01-16Add author sections to the manpagesMukund Sivaraman
2010-01-16Add see-also sections to the manpagesMukund Sivaraman
2010-01-10Happy new year 2010!Michael Adam
2009-11-14Make asciidoc a requirement for building TinyproxyMukund Sivaraman
asciidoc is necessary as the version number is added during configure into the asciidoc manpage sources. So simply bundling a pre-generated manpage won't do.
2009-11-14Revert "Don't cleanup generated and dist'ed manpages"Mukund Sivaraman
This reverts commit 276ca8369dbe82ddba5e72684becc5e774169157.
2009-11-14Use located a2x binary instead of hard-coded nameMukund Sivaraman
2009-11-14Mark all generated stuff with silent rulesMukund Sivaraman
2009-11-14Don't cleanup generated and dist'ed manpagesMukund Sivaraman
2009-11-10docs: update description of STATHOST in tinyproxy(8)Michael Adam
Michael
2009-09-14docs: Fix .gitignoreMukund Sivaraman
2009-09-14Rename doc directory to docsMukund Sivaraman