Add Makefile, README, and manual page

1 files changed, 54 insertions, 0 deletions

diff --git a/temp-postgres.1 b/temp-postgres.1
new file mode 100644
index 0000000..caf4b78
--- /dev/null
+++ b/temp-postgres.1
@@ -0,0 +1,54 @@
+.\" Copyright (c) 2022 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: May 19 2022 $
+.Dt TEMP-POSTGRES 1
+.Os
+.Sh NAME
+.Nm temp-postgres
+.Nd temporary PostgreSQL server
+.Sh SYNOPSIS
+.Nm temp-postgres
+.Ar database
+.Ar superuser
+.Sh DESCRIPTION
+The
+.Nm
+utility runs the PostgreSQL server off a temporary data directory.
+.Pp
+It expects exactly two arguments:
+a
+.Ar database
+name
+and a
+.Ar superuser
+name.
+You may also set the port using PGPORT, see
+.Xr postgres 1 .
+.Sh EXIT STATUS
+.Ex -std temp-postgres
+.Sh EXAMPLES
+Create a temporary database "test" with superuser "alex":
+.Bd -literal -offset indent
+$ temp-postgres test alex
+.Ed
+.Pp
+Connect to the "test" database:
+.Bd -literal -offset indent
+$ psql --host=localhost test alex
+.Ed
+.Sh SEE ALSO
+.Xr postgres 1 ,
+.Xr psql 1
+.Sh AUTHORS
+.An Stefan Kreutz Aq Mt mail@skreutz.com