File: basexserver.1

package info (click to toggle)
basex 7.3-1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 7,924 kB
  • sloc: java: 86,870; xml: 921; sh: 149; makefile: 5
file content (142 lines) | stat: -rw-r--r-- 3,112 bytes parent folder | download | duplicates (2)
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
.\"Text automatically generated by txt2man
.TH basexserver 1 "26 June 2012" "" "The XML Database"
.SH NAME
\fBbasexserver \fP- XML database system and XPath/XQuery processor (server mode)
\fB
.SH SYNOPSIS
.nf
.fam C
\fBbasexserver\fP [\fB-cdeipSz\fP] [\fIstop\fP]

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
\fBbasexserver\fP starts the server mode of the native XML database system \fBbasex\fP(1) on default port 1984.
.SH OPTIONS
A short description of option can be obtained from
.PP
.nf
.fam C
    $ basexserver \-h

.fam T
.fi
or by browsing http://docs.basex.org/wiki/Startup_Options#BaseX_Server
.SH USER MANAGEMENT
On first startup a user 'admin' with default password 'admin' exists (make sure to change this)!
.PP
Admin permissions are needed to execute one of the following processes.
.IP \(bu 3
Creating user 'test' with password 'test':
.PP
.nf
.fam C
   > CREATE USER test test

.fam T
.fi
As global permissions valid options are 'none', 'read', 'write', 'create' and 'admin'.
.IP \(bu 3
Revoking all global permissions from user 'test':
.PP
.nf
.fam C
   > GRANT none TO test

.fam T
.fi
Valid local permissions are 'none', 'read' and 'write'.
.IP \(bu 3
Granting write permission on database 'factbook' to user 'test':
.PP
.nf
.fam C
    > GRANT write ON factbook TO test

.fam T
.fi
Note: Local permissions overwrite global permissions. As a consequence, the 'test' user will only be allowed to access (i.e., read and write) the 'factbook' database. If no local permissions are set, the global rights are inherited.
.IP \(bu 3
Showing global permissions:
.PP
.nf
.fam C
    > SHOW USERS

.fam T
.fi
.IP \(bu 3
Showing local permissions on database 'factbook':
.PP
.nf
.fam C
   > SHOW USERS ON factbook

.fam T
.fi
.IP \(bu 3
Dropping of user 'test':
.PP
.nf
.fam C
   > DROP USER test

.fam T
.fi
Further details on user management are to be found in the BaseX Documentation
Wiki (http://docs.basex.org/wiki/User_Management).
.SH DATABASE COMMANDS
A list of supported Database commands can be obtained from
.PP
.nf
.fam C
    $ basexserver \-ic help

.fam T
.fi
or by browsing http://docs.basex.org/wiki/Commands
.SH SEE ALSO
\fBbasexclient\fP(1), \fBbasex\fP(1), \fBbasexgui\fP(1)
.TP
.B
~/.basex
BaseX (standalone and server) properties
.TP
.B
~/.basexgui
BaseX additional GUI properties 
.TP
.B
~/.basexperm
user name, passwords, and permissions
.TP
.B
~/.basexevents
contains all existing events
.TP
.B
~/BaseXData
Default database directory
.TP
.B
~/BaseXData/.logs
Server logs
.TP
.B
~/BaseXRepo
Package repository
.PP
BaseX Documentation Wiki: http://docs.basex.org
.SH HISTORY
BaseX started as a research project of the Database and Information Systems
Group (DBIS) at the University of Konstanz in 2005 and soon turned into a
feature-rich open source XML database and XPath/XQuery processor.
.SH LICENSE
New (3-clause) BSD License
.SH AUTHOR
BaseX is developed by a bunch of people called 'The BaseX Team'
<http://basex.org/about-us/> led by Christian Gruen <cg@basex.org>.
.PP
The man page was written by Alexander Holupirek <alex@holupirek.de> while packaging BaseX for Debian GNU/Linux.