Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 7ee9464

Browse files
committed
various docs changes requested by Bryan
1 parent a0990e1 commit 7ee9464

File tree

5 files changed

+46
-175
lines changed

5 files changed

+46
-175
lines changed

doc/man/bki.5

Lines changed: 25 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,33 @@
11
.\" This is -*-nroff-*-
2-
.\" XXX standard disclaimer belongs here....
3-
.\" $Header: /cvsroot/pgsql/doc/man/Attic/bki.5,v 1.1.1.1 1996/08/18 22:14:20 scrappy Exp $
4-
.TH BKI FILES 01/23/93 Postgres95 Postgres95
2+
.\" $Header: /cvsroot/pgsql/doc/man/Attic/bki.5,v 1.2 1996/11/09 10:29:44 scrappy Exp $
3+
.TH BKI 5 11/04/96 Postgres Postgres
54
.SH NAME
6-
\&.../src/backend/obj/{local,dbdb}.bki \(em template scripts
5+
*.bki
76
.SH DESCRIPTION
8-
Backend Interface (BKI) files are scripts that describe the contents
9-
of the initial Postgres database. This database is constructed during
10-
system installation, by the
11-
.IR initdb
12-
command.
13-
.IR Initdb
14-
executes the Postgres backend with a special set of flags, that cause it
15-
to consume the BKI scripts and bootstrap a database.
7+
Backend Interface (BKI) files are scripts that are input to the postgres
8+
backend running in the special "bootstrap" mode that allows it to perform
9+
database functions without a database system already existing. BKI files
10+
can therefore be used to create the database system in the first place.
1611
.PP
17-
These files are automatically generated from system header files
18-
during installation. They are not intended for use by humans, and you
19-
do not need to understand their contents in order to use Postgres. These
20-
files are copied to
21-
.nf
22-
\&.../files/{global1,local1_XXX}.bki
23-
.fi
24-
during system installation.
25-
.PP
26-
All new user databases will be created by copying the template
27-
database that Postgres constructs from the BKI files. Thus, a simple way
28-
to customize the template database is to let the Postgres initialization
29-
script create it for you, and then to run the terminal monitor to make
30-
the changes you want.
12+
.IR Initdb
13+
uses BKI files to do just that -- create a database system. However,
14+
.IR initdb's
15+
BKI files are generated internally. It generates them using the files
16+
global1.bki.source and local1.template1.bki.source, which it finds in the
17+
Postgres "library" directory. They get installed there as part of installing
18+
Postgres. These .source files get build as part of the Postgres build
19+
process, by a build program called
20+
.IR genbki. Genbki
21+
takes as input Postgres source files that double as
22+
.IR genbki
23+
input that builds tables and C header files that describe those
24+
tables.
3125
.PP
3226
The Postgres backend interprets BKI files as described below. This
33-
description will be easier to understand if the example in
34-
\*(lq.../files/global1.bki\*(rq is at hand.
27+
description will be easier to understand if the global1.bki.source file is
28+
at hand as an example. (As explained above, this .source file isn't quite
29+
a BKI file, but you'll be able to guess what the resulting BKI file would be
30+
anyway).
3531
.PP
3632
Commands are composed of a command name followed by space separated
3733
arguments. Arguments to a command which begin with a \*(lq$\*(rq are
@@ -220,5 +216,4 @@ close pg_opclass
220216
.SH "SEE ALSO"
221217
initdb(1),
222218
createdb(1),
223-
createdb(l),
224-
template(files).
219+
create_database(l).

doc/man/files.5

Lines changed: 0 additions & 37 deletions
This file was deleted.

doc/man/pg_hba.5

Lines changed: 0 additions & 43 deletions
This file was deleted.

doc/man/pg_hba.conf.5

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.\" This is -*-nroff-*-
2+
.\" $Header: /cvsroot/pgsql/doc/man/Attic/pg_hba.conf.5,v 1.1 1996/11/09 10:29:49 scrappy Exp $
3+
.TH pg_hba.conf 5 11/04/96 Postgres Postgres
4+
.SH NAME
5+
$PGDATA/pg_hba.conf
6+
.SH DESCRIPTION
7+
"Host-based access control" is the name for the basic controls Postgres
8+
exercises on what clients are allowed to access a database system.
9+
It is called that because one of the factors that can control access is
10+
from what host the client is connecting.
11+
.PP
12+
Each database system contains a file named "pg_hba.conf", in its PGDATA
13+
directory, that controls who can connect to that database system.
14+
.PP
15+
The exact format of the pg_hba.conf file is described in the comments at
16+
the top of the sample file pg_hba.conf.sample, which resides in the
17+
Postgres "library" directory.
18+
19+
.SH "SEE ALSO"
20+
introduction(1).
21+

doc/man/template.5

Lines changed: 0 additions & 65 deletions
This file was deleted.

0 commit comments

Comments
 (0)