diff options
| -rw-r--r-- | doc/man/bki.5 | 55 | ||||
| -rw-r--r-- | doc/man/files.5 | 37 | ||||
| -rw-r--r-- | doc/man/pg_hba.5 | 43 | ||||
| -rw-r--r-- | doc/man/pg_hba.conf.5 | 21 | ||||
| -rw-r--r-- | doc/man/template.5 | 65 |
5 files changed, 46 insertions, 175 deletions
diff --git a/doc/man/bki.5 b/doc/man/bki.5 index 4c6f68c7dea..b060bfff49f 100644 --- a/doc/man/bki.5 +++ b/doc/man/bki.5 @@ -1,37 +1,33 @@ .\" This is -*-nroff-*- -.\" XXX standard disclaimer belongs here.... -.\" $Header: /cvsroot/pgsql/doc/man/Attic/bki.5,v 1.1.1.1 1996/08/18 22:14:20 scrappy Exp $ -.TH BKI FILES 01/23/93 Postgres95 Postgres95 +.\" $Header: /cvsroot/pgsql/doc/man/Attic/bki.5,v 1.2 1996/11/09 10:29:44 scrappy Exp $ +.TH BKI 5 11/04/96 Postgres Postgres .SH NAME -\&.../src/backend/obj/{local,dbdb}.bki \(em template scripts +*.bki .SH DESCRIPTION -Backend Interface (BKI) files are scripts that describe the contents -of the initial Postgres database. This database is constructed during -system installation, by the -.IR initdb -command. -.IR Initdb -executes the Postgres backend with a special set of flags, that cause it -to consume the BKI scripts and bootstrap a database. +Backend Interface (BKI) files are scripts that are input to the postgres +backend running in the special "bootstrap" mode that allows it to perform +database functions without a database system already existing. BKI files +can therefore be used to create the database system in the first place. .PP -These files are automatically generated from system header files -during installation. They are not intended for use by humans, and you -do not need to understand their contents in order to use Postgres. These -files are copied to -.nf -\&.../files/{global1,local1_XXX}.bki -.fi -during system installation. -.PP -All new user databases will be created by copying the template -database that Postgres constructs from the BKI files. Thus, a simple way -to customize the template database is to let the Postgres initialization -script create it for you, and then to run the terminal monitor to make -the changes you want. +.IR Initdb +uses BKI files to do just that -- create a database system. However, +.IR initdb's +BKI files are generated internally. It generates them using the files +global1.bki.source and local1.template1.bki.source, which it finds in the +Postgres "library" directory. They get installed there as part of installing +Postgres. These .source files get build as part of the Postgres build +process, by a build program called +.IR genbki. Genbki +takes as input Postgres source files that double as +.IR genbki +input that builds tables and C header files that describe those +tables. .PP The Postgres backend interprets BKI files as described below. This -description will be easier to understand if the example in -\*(lq.../files/global1.bki\*(rq is at hand. +description will be easier to understand if the global1.bki.source file is +at hand as an example. (As explained above, this .source file isn't quite +a BKI file, but you'll be able to guess what the resulting BKI file would be +anyway). .PP Commands are composed of a command name followed by space separated arguments. Arguments to a command which begin with a \*(lq$\*(rq are @@ -220,5 +216,4 @@ close pg_opclass .SH "SEE ALSO" initdb(1), createdb(1), -createdb(l), -template(files). +create_database(l). diff --git a/doc/man/files.5 b/doc/man/files.5 deleted file mode 100644 index 52a17108f1c..00000000000 --- a/doc/man/files.5 +++ /dev/null @@ -1,37 +0,0 @@ -.\" This is -*-nroff-*- -.\" XXX standard disclaimer belongs here.... -.\" $Header: /cvsroot/pgsql/doc/man/Attic/files.5,v 1.1.1.1 1996/08/18 22:14:24 scrappy Exp $ -.TH INFORMATION FILES 01/23/93 Postgres95 Postgres95 -.SH "Section 8 \(em Files" -.SH "General Information" -.SH OVERVIEW -This section describes -some of the important files used by Postgres. -.SH NOTATION -\*(lq.../\*(rq at the front of file names represents the path to the -postgres user's home directory. Anything in square brackets -.RB (\*(lq "[" \*(rq -and -.RB \*(lq "]" \*(rq) -is optional. -Anything in braces -.RB (\*(lq "{" \*(rq -and -.RB \*(lq "}" \*(rq) -can be repeated 0 or more times. Parentheses -.BR (\*(lq "(" \*(rq -and -.BR \*(lq ")" \*(rq) -are used to group boolean expressions. -.BR | -is the boolean operator -.SM OR\c -\&. -.SH BUGS -The descriptions of -.nf - .../data/PG_VERSION, - .../data/base/*/PG_VERSION, -.fi -the temporary sort files, and the database debugging trace files are -absent. diff --git a/doc/man/pg_hba.5 b/doc/man/pg_hba.5 deleted file mode 100644 index 1e08ba8ca6d..00000000000 --- a/doc/man/pg_hba.5 +++ /dev/null @@ -1,43 +0,0 @@ -.\" This is -*-nroff-*- -.\" XXX standard disclaimer belongs here.... -.\" $Header: /cvsroot/pgsql/doc/man/Attic/pg_hba.5,v 1.1.1.1 1996/08/18 22:14:26 scrappy Exp $ -.TH PG_HBA FILES 01/20/96 Postgres95 Postgres95 -.SH NAME -$PGDATA/pg_hba \(em host-based access control -.SH DESCRIPTION -Postgres provides host-based access control through the file -.BR "pg_hba". -This file is stored in $PGDATA and should have proper file permissions -so that casual users cannot modify it. The file stores permissions -information about which hosts are authorized to access databases. -.PP -The file consists of lines of three columns. The first column lists the -name of the database. The second column lists the IP address of clients -machines that are authorized to connect, and the third column provides a -bit mask for the IP address. Lines which begin with '#' are considered -comments. -.PP -The keyword "all" can be used to apply to all database names. Each -column can contain strings of at most 80 characters, and each database -may have up to 255 configuration lines that apply. (80 and 255 are -constants that can be changed at Postgres compile time by altering the -#defines MAX_TOKEN and MAX_LINES in src/backend/libpq/auth.c) -.PP -Below is the default pg_hba file that is installed. -.nf -# -# Example config file for Postgres95 host based access -# -# Lines starting with "all" apply to all databases. Otherwise the first -# column has to match the name of the database being connected to. Up to -# ten config lines can apply to each database. Mask specifies bits that -# aren't counted. After those bits are taken out, the connection address -# must match the address in the middle column. -# -# <name> <address> <mask> -# -all 127.0.0.1 0.0.0.0 -.fi -.SH "SEE ALSO" -introduction(1). - diff --git a/doc/man/pg_hba.conf.5 b/doc/man/pg_hba.conf.5 new file mode 100644 index 00000000000..5a5673e7778 --- /dev/null +++ b/doc/man/pg_hba.conf.5 @@ -0,0 +1,21 @@ +.\" This is -*-nroff-*- +.\" $Header: /cvsroot/pgsql/doc/man/Attic/pg_hba.conf.5,v 1.1 1996/11/09 10:29:49 scrappy Exp $ +.TH pg_hba.conf 5 11/04/96 Postgres Postgres +.SH NAME +$PGDATA/pg_hba.conf +.SH DESCRIPTION +"Host-based access control" is the name for the basic controls Postgres +exercises on what clients are allowed to access a database system. +It is called that because one of the factors that can control access is +from what host the client is connecting. +.PP +Each database system contains a file named "pg_hba.conf", in its PGDATA +directory, that controls who can connect to that database system. +.PP +The exact format of the pg_hba.conf file is described in the comments at +the top of the sample file pg_hba.conf.sample, which resides in the +Postgres "library" directory. + +.SH "SEE ALSO" +introduction(1). + diff --git a/doc/man/template.5 b/doc/man/template.5 deleted file mode 100644 index 739ef3bf061..00000000000 --- a/doc/man/template.5 +++ /dev/null @@ -1,65 +0,0 @@ -.\" This is -*-nroff-*- -.\" XXX standard disclaimer belongs here.... -.\" $Header: /cvsroot/pgsql/doc/man/Attic/template.5,v 1.1.1.1 1996/08/18 22:14:28 scrappy Exp $ -.TH TEMPLATE FILES 01/23/93 Postgres95 Postgres95 -.SH Template -.SH NAME -\&.../data/files/global1.bki \(em global database template -.br -\&.../data/files/local1_XXX.bki \(em local database template -.br -\&.../data/files/template1/* \(em default database template -.SH DESCRIPTION -These files contain scripts which direct the construction of -databases. Note that the \*(lqglobal1.bki\*(rq and -\*(lqtemplate1_local.bki\*(rq files are installed automatically when -the Postgres super-user runs -.IR initdb . -These files are copied from -.nf -\&.../src/backend/obj/{dbdb,local}.bki -.fi -The databases which are generated by the template scripts are normal -databases. Consequently, you can use the terminal monitor or some -other frontend on a template database to simplify the customization -task. That is, there is no need to express everything about your -desired initial database state using a BKI template script, because -the database state can be tuned interactively. -.PP -The system catalogs consist of classes of two types: global and local. -There is one copy of each global class that is shared among all -databases at a site. Local classes, on the other hand, are not -accessible except from their own database. -.PP -The file -.nf -\&.../data/files/global1.bki -.fi -specifies the process used in the creation of global (shared) classes -by -.IR createdb . -Similarly, the -.nf -\&.../files/local1_XXX.bki -.fi -files specify the process used in the creation of local (unshared) -catalog classes for the \*(lqXXX\*(rq template database. -\*(lqXXX\*(rq may be any string of 16 or fewer printable characters. -If no template is specified in a -.IR createdb -command, -then the template in -.nf -\&.../files/local1_template1.bki -.fi -is used. -.PP -The .bki files are generated from C source code by an inscrutable set -of AWK scripts. -.SH BUGS -Postgres Version \*(PV does not permit users to have separate template -databases. -.SH "SEE ALSO" -bki(files), -initdb(1), -createdb(1). |