From cbe227b8e451d64847a33eaba0ec9439e55fde4e Mon Sep 17 00:00:00 2001 From: Marko Kreen Date: Tue, 28 Aug 2007 20:50:22 +0000 Subject: [PATCH] more doc updates --- config.mak.in | 1 + doc/Makefile | 3 ++- doc/fixman.py | 4 ++++ doc/pgbouncer.cmdline.txt | 6 +----- doc/pgbouncer.config.txt | 17 ++++++++++++++++- doc/todo.txt | 1 + 6 files changed, 25 insertions(+), 7 deletions(-) create mode 100755 doc/fixman.py diff --git a/config.mak.in b/config.mak.in index 93a587f..1e31cbb 100644 --- a/config.mak.in +++ b/config.mak.in @@ -16,6 +16,7 @@ datarootdir = @datarootdir@ sysconfdir = @sysconfdir@ sharedstatedir = @sharedstatedir@ docdir = @docdir@ +mandir = @mandir@ top_builddir = @top_builddir@ srcdir = @srcdir@ diff --git a/doc/Makefile b/doc/Makefile index ad4a040..b6d6574 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -29,7 +29,8 @@ pgbouncer.5: pgbouncer.config.xml xmlto man $< %.xml: %.txt - asciidoc -b docbook -d manpage $< + asciidoc -b docbook -d manpage -o - $< \ + | python fixman.py > $@ %.html: %.txt asciidoc -a toc $< diff --git a/doc/fixman.py b/doc/fixman.py new file mode 100755 index 0000000..b227180 --- /dev/null +++ b/doc/fixman.py @@ -0,0 +1,4 @@ +#! /usr/bin/env python +import sys,re +# add empty after to force line break +sys.stdout.write(re.sub(r"\s+", r"\g<0>", sys.stdin.read())) diff --git a/doc/pgbouncer.cmdline.txt b/doc/pgbouncer.cmdline.txt index 3c454ff..17db7e8 100644 --- a/doc/pgbouncer.cmdline.txt +++ b/doc/pgbouncer.cmdline.txt @@ -46,14 +46,10 @@ database +pgbouncer+. Basic setup and usage as following. -This example assumes the +postgres+ user is given administrative -permissions from +pgbouncer.ini+ and that +pgbouncer+ is configured to -be listening on +localhost:6543+. - 1. Create config file. Details in +pgbouncer(5)+. Simplest: [databases] - template1 = host=127.0.0.1 dbname=template1 + template1 = host=127.0.0.1 port=5432 dbname=template1 [pgbouncer] listen_port = 6543 diff --git a/doc/pgbouncer.config.txt b/doc/pgbouncer.config.txt index b178a3a..b431340 100644 --- a/doc/pgbouncer.config.txt +++ b/doc/pgbouncer.config.txt @@ -102,7 +102,22 @@ statement:: ==== max_client_conn ==== -Maximum number of client connections allowed. +Maximum number of client connections allowed. When increased then the file +descriptor limits should also be increased. Note that actual number of file +descriptiors used is more that max_client_conn. Theoretical maximum used is: + + max_client_conn * max_pool_size * total_databases * total_users + +if each user connects under it's own username to server. If database user +is specified in connect string (all users connect under same username), +the theoretical maximum is: + + max_client_conn * max_pool_size * total_databases + +The theoretical maximum is never reaches, unless somebody deliberately +crafts special load for it. Still, it means you should give fds liberately. + +Search for `ulimit` in your favourite shell man page. Default: 100 diff --git a/doc/todo.txt b/doc/todo.txt index 5945b53..9fea30c 100644 --- a/doc/todo.txt +++ b/doc/todo.txt @@ -7,6 +7,7 @@ then issue rollback and keep it * suspend_timeout - drop stalled conns * rename disable_varcache to track_parameters + * some preliminary notification that fd limit is full == Ver 1.0.9 == -- 2.40.0