← Back to branch summary

~ubuntu-branches/ubuntu/trusty/hyperestraier/trusty

« back to all changes in this revision

Viewing changes to debian/estmaster.1

  • Committer: Bazaar Package Importer
  • Author(s): Steve Langasek
  • Date: 2006-11-14 05:28:32 UTC
  • mfrom: (2.1.4 feisty)
  • Revision ID: james.westby@ubuntu.com-20061114052832-0lzqzcefn8mt4yqe
Tags: 1.4.9-1.1
* Non-maintainer upload.
* High-urgency upload for RC bugfix.
* Set HOME=$(CURDIR)/junkhome when building, otherwise the package build
  will incorrectly look for headers there -- and fail when the directory
  exists and is unreadable, as happens sometimes on sudo-using
  autobuilders!

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/estmaster.1
1
 
.\"                                      Hey, EMACS: -*- nroff -*-
2
 
.\" First parameter, NAME, should be all caps
3
 
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4
 
.\" other parameters are allowed: see man(7), man(1)
5
 
.TH ESTMASTER 1 "2005-07-21" "Man Page" "HyperEstraier"
6
 
.\" Please adjust this date whenever revising the manpage.
7
 
.\"
8
 
.\" Some roff macros, for reference:
9
 
.\" .nh        disable hyphenation
10
 
.\" .hy        enable hyphenation
11
 
.\" .ad l      left justify
12
 
.\" .ad b      justify to both left and right margins
13
 
.\" .nf        disable filling
14
 
.\" .fi        enable filling
15
 
.\" .br        insert line break
16
 
.\" .sp <n>    insert n+1 empty lines
17
 
.\" for manpage-specific macros, see man(7)
18
 
.SH NAME
19
 
estmaster \- node master server
20
 
.SH SYNOPSIS
21
 
.B estmaster init
22
 
.RI "[-ex] " rootdir
23
 
.br
24
 
.B estmaster start
25
 
.RI "[-bg] [-st] " rootdir
26
 
.br
27
 
.B estmaster stop
28
 
.I rootdir
29
 
.br
30
 
.B estmaster unittest
31
 
.I rootdir
32
 
.br
33
 
.B estmaster crypt
34
 
.IR key " [" hash ]
35
 
.br
36
 
.SH DESCRIPTION
37
 
This manual page documents briefly the
38
 
.B estmaster
39
 
commands.
40
 
.PP
41
 
\fBestmaster\fP is a program that manage the node master.  The name of
42
 
a sub command is specified by the first argument. Other arguments are
43
 
parsed according to each sub command. The argument \fIrootdir\fP specifies
44
 
the server root directory which contains configuration file and so on.
45
 
.PP
46
 
All sub commands return 0 if the operation is success, else return 1. A running
47
 
node master finishs with closing the database when it catchs the signal 2
48
 
(SIGINT), 3 (SIGQUIT), or 15 (SIGTERM). Moreover, when a running node master
49
 
catches the signal 1 (SIGHUP), the process is re-start and re-read the
50
 
configuration files.
51
 
.PP
52
 
A running node server sould be finished by valid means by command line or via
53
 
network. Otherwise, the index may be broken.
54
 
.PP
55
 
A summary of options is included below.
56
 
For a comlete description, see /usr/share/doc/hyperestraier/nguide-en.html.
57
 
.PP
58
 
.B estmaster init
59
 
.RI "[-ex] " rootdir
60
 
.br
61
 
Create the server root directory.
62
 
.RS
63
 
.PP
64
 
If \fB-ex\fP is specified, some users and some nodes are set for example. By
65
 
default, only a super user whose name and password are both "admin" is set.
66
 
.PP
67
 
.RE
68
 
.PP
69
 
 
70
 
.B estmaster start
71
 
.RI "[-bg] [-st] " rootdir
72
 
.br
73
 
 Start the node master.
74
 
.RS
75
 
.PP
76
 
If \fB-bg\fP is specified, the server runs in background as a daemon process.
77
 
.PP
78
 
If \fB-st\fP is specified, the server runs in single thread mode.
79
 
.RE
80
 
.PP
81
 
 
82
 
.B estmaster stop
83
 
.I rootdir
84
 
.br
85
 
Stop the running node master.
86
 
.PP
87
 
 
88
 
.B estmaster unittest
89
 
.I rootdir
90
 
.br
91
 
 Perform unit tests.
92
 
.PP
93
 
 
94
 
.B estmaster crypt
95
 
.IR key " [" hash ]
96
 
.br
97
 
Output an encrypted string of a string.
98
 
.RS
99
 
.PP
100
 
\fIkey\fP specifies a target string.
101
 
.PP
102
 
If \fIhash\fP is specified, it checks whether the key and the hash matches.
103
 
.RE
104
 
.PP
105
 
 
106
 
.SH EXAMPLES
107
 
.PP
108
 
For preparation for the node master, create the server root directory which
109
 
includes configuration files and indexes. Perform the following command and a
110
 
directory "casket" will be created.
111
 
.PP
112
 
\fB     estmaster init casket\fP
113
 
.PP
114
 
Next, start the node master. Perform the following command.
115
 
.PP
116
 
\fB     estmaster start casket\fP
117
 
.PP
118
 
To stop the node master, input Ctrl-D on the terminal on which the node master
119
 
is running or perform the following command on another terminal.
120
 
.PP
121
 
\fB     estmaster stop casket\fP
122
 
.PP
123
 
 
124
 
.SH SEE ALSO
125
 
.BR estcmd (1)
126
 
.BR estcall (1),
127
 
.BR estload (1),
128
 
.BR estconfig (1).
129
 
.SH AUTHOR
130
 
estraier was written by Mikio Hirabayashi <mikio at users.sourceforge.net>.
131
 
.PP
132
 
This manual page was written by Fumitoshi UKAI <ukai@debian.or.jp>,
133
 
for the Debian project (but may be used by others).
134
 
 
135
 
 
136
 
 
137
 
 
138
 
 
139
 
 
140
 
 
141