summaryrefslogtreecommitdiff
path: root/temp-postgres.1
diff options
context:
space:
mode:
authorStefan Kreutz <mail@skreutz.com>2026-04-30 10:10:46 +0200
committerStefan Kreutz <mail@skreutz.com>2026-04-30 10:10:46 +0200
commit46a3d2ba70decd1931e13c190bfa49217e57718d (patch)
tree49bc767c52d0cb4cf8443782cae1cc641ef59343 /temp-postgres.1
parent47421e41def84ab92a52906f01266b1044fbfe29 (diff)
downloadtemp-postgres-46a3d2ba70decd1931e13c190bfa49217e57718d.tar.gz
Rewrite in async Rust
Diffstat (limited to 'temp-postgres.1')
-rw-r--r--temp-postgres.198
1 files changed, 0 insertions, 98 deletions
diff --git a/temp-postgres.1 b/temp-postgres.1
deleted file mode 100644
index c3e395d..0000000
--- a/temp-postgres.1
+++ /dev/null
@@ -1,98 +0,0 @@
-.\" Copyright (c) 2022, 2026 Stefan Kreutz <mail@skreutz.com>
-.\"
-.\" Permission to use, copy, modify, and distribute this software for any
-.\" purpose with or without fee is hereby granted, provided that the above
-.\" copyright notice and this permission notice appear in all copies.
-.\"
-.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-.Dd $Mdocdate: April 15 2026 $
-.Dt TEMP-POSTGRES 1
-.Os
-.Sh NAME
-.Nm temp-postgres
-.Nd temporary PostgreSQL server
-.Sh SYNOPSIS
-.Nm temp-postgres
-.Op options
-.Op Fl -
-.Op Ar command
-.Sh DESCRIPTION
-The
-.Nm
-utility runs the PostgreSQL server off a temporary data directory.
-.Pp
-The options are as follows:
-.Bl -tag -width Ds
-.It Fl h , -help
-Print help.
-.It Fl d , -dbname Ar dbname
-Database name.
-Defaults to the name of the effective user.
-.It Fl u , -username Ar username
-PostgreSQL user name.
-Defaults to the name of the effective user.
-.It Fl -symlink Ar path
-Create a symlink to the directory in which the UNIX domain socket file is stored.
-.El
-.Pp
-.Nm
-can optionally execute a given
-.Ar command
-once the PostgreSQL server is ready.
-If so,
-.Nm
-will pass the following environment variables to the
-.Ar command :
-.Bl -tag -width Ds
-.It Ev PGHOST
-Absolute path to the directory in which the UNIX domain socket file is stored.
-.It Ev PGDATABASE
-Database name.
-.It Ev PGUSER
-PostgreSQL user name.
-.It Ev DATABASE_URI
-Connection URI.
-.It Ev DATABASE_URL
-Connection URI.
-.El
-.Pp
-See also the
-.Lk https://www.postgresql.org/docs/current/libpq-envars.html "environment variables used by libpg" ,
-and the
-.Lk https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING-URIS "connection URI scheme understood by libpg" .
-.Sh EXIT STATUS
-.Ex -std temp-postgres
-.Sh EXAMPLES
-Create and serve a temporary database:
-.Bd -literal -offset indent
-temp-postgres
-.Ed
-.Pp
-Wrap the
-.Xr psql 1
-command to connect to the temporary database once the server is ready:
-.Bd -literal -offset indent
-temp-postgres -- psql
-.Ed
-.Pp
-Set up a symlink to enable static client configuration:
-.Bd -literal -offset indent
-temp-postgres --symlink ./db
-psql --host "$(realpath ./db)"
-.Ed
-.Pp
-Specify a database name, and PostgreSQL user name:
-.Bd -literal -offset indent
-temp-postgres --dbname myproject --username alex
-.Ed
-.Sh SEE ALSO
-.Xr postgres 1 ,
-.Xr psql 1
-.Sh AUTHORS
-.An Stefan Kreutz Aq Mt mail@skreutz.com
Generated by cgit. See skreutz.com for my tech blog and contact information.