mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git

Matthew Swift
25.08.2011 73ff677c68a93eaefca51632b3b89b5eadffaf36
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
'\" t
.\"     Title: create-rc-script
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "CREATE\-RC\-SCRIPT" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
create-rc-script \- script to manage OpenDJ as a service on UNIX
.SH "SYNOPSIS"
.HP \w'\fBcreate\-rc\-script\fR\ 'u
\fBcreate\-rc\-script\fR {options}
.SH "DESCRIPTION"
.PP
Create an RC script that may be used to start, stop, and restart the directory server on UNIX\-based systems\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-f, \-\-outputFile {path}\fR
.RS 4
The path to the output file to create\&.
.RE
.PP
\fB\-j, \-\-javaHome {path}\fR
.RS 4
The path to the Java installation that should be used to run the server\&.
.RE
.PP
\fB\-J, \-\-javaArgs {args}\fR
.RS 4
A set of arguments that should be passed to the JVM when running the server\&.
.RE
.PP
\fB\-u, \-\-userName {userName}\fR
.RS 4
The name of the user account under which the server should run\&.
.RE
.SS "General Options"
.PP
\fB\-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
> 0
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.PP
The following example adds a script to start OpenDJ at boot time on a Debian\-based system, and then updates the runlevel system to use the script\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ sudo create\-rc\-script \-f /etc/init\&.d/opendj \-u mark
$ sudo update\-rc\&.d opendj
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
To view a copy of this license, visit
http://creativecommons.org/licenses/by-nc-nd/3.0/
or send a letter to Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp