File: msql.1

package info (click to toggle)
msql 2.0.3-5
  • links: PTS
  • area: non-free
  • in suites: hamm, slink
  • size: 3,596 kB
  • ctags: 2,483
  • sloc: ansic: 34,769; sh: 1,309; yacc: 1,084; perl: 328; makefile: 267
file content (97 lines) | stat: -rw-r--r-- 3,439 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
.\" msql - Mini SQL Terminal Monitor
.\" Copyright (c) 1995  Martin Schulze <joey@office.individual.net>
.\" 
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 2 of the License, or
.\" (at your option) any later version.
.\" 
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\" 
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc.,59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
.\"
.\" This manual page is written especially for Debian GNU/Linux.
.\"
.TH MSQL 1 "19 Nov 1996" "Mini SQL" "Commands"
.SH NAME
msql \- Mini SQL Terminal Monitor
.SH SYNOPSIS
.B msql
.RB [ " \-h \fIhost\fP " ]
.I database
.SH DESCRIPTION
Like all database applications, mSQL provides a program that allows a user
to interactively submit queries to the database engine.  In the case of mSQL,
it's a program simply called `msql'.  It requires one command line argument,
being the name of the database to access.  Once started, there is no way to
swap databases without restarting the program.  this program is the main user
interface to the database engine.  This monitor hasn been modelled after the
original Ingres (and the subsequent Postgres) monitor program.

See
.BR libmsql (3)
for Details in specifying a
.IR host name.

You may get full access to the
.I database
via mSQL queries according configured access rules.  Each query must be followed
by `\g' (see later) to get sent to the engine.  See
.BR msql (5)
for the supported subset of ANSI-SQL.

.SH COMMANDS
Queries and commands are distinguished due to commands being prefixed by backslashes.

.TP
.B "\\\\e"
Edit the last query using the vi editor.  If you wish to use an editor other than
vi, msql will honour the convention of using the contents of the VISUAL or EDITOR
environment variable as an alternate editor.
.TP
.B "\\\\g"
Each query that is sent to the database engine must be followed by this command.
It tells the monitor to "go" and send the query to the engine.  If `\\g' ist entered
without entering a new query, the last query to be submitted will be resubmitted.
.TP
.B "\\\\p"
The contents of the query buffer can be displayed more than once.
.TP
.B "\\\\q"
Quit the mSQL monitor program.

.SH ENVIRONMENT
The mSQL program family may be controlled by some environment variables.
They override compiled-in default values but may be overridden by
commandline arguments.

.TP
.I MSQL_TCP_PORT
Specifies the TCP port on which the database engine listen to requests.
.TP
.I MSQL_UNIX_PORT
Specifies the unix domain socket that shall be used to contact the
engine if it runs on the local host.
.TP
.I MINERVA_DEBUG
Specifies debuging.  See
.BR libmsql (3)
for possible values.
.TP
.IR VISUAL ", " EDITOR
If the query shall be edited you may specify your favourite editor
here.

.SH AUTHOR
Mini SQL has been written by David Hughes of Bond University,
Australia as part of the Minerva Network Management
Environment.  He may be reached via electronic mail using
bambi@Bond.edu.au.
.SH "SEE ALSO"
.BR libmsql (3),
.BR msql (5).