src/java.rmi/share/man/rmiregistry.1
author rehn
Fri, 29 Nov 2019 12:09:25 +0100
changeset 59325 3636bab5e81e
parent 55140 d4890c3721be
permissions -rw-r--r--
8234086: VM operation can be simplified Reviewed-by: kbarrett, dholmes, dcubed
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
55140
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
     1
.\" Copyright (c) 1994, 2019, Oracle and/or its affiliates. All rights reserved.
31876
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
     2
.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
     3
.\"
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
     4
.\" This code is free software; you can redistribute it and/or modify it
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
     5
.\" under the terms of the GNU General Public License version 2 only, as
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
     6
.\" published by the Free Software Foundation.
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
     7
.\"
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
     8
.\" This code is distributed in the hope that it will be useful, but WITHOUT
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
     9
.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    10
.\" FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    11
.\" version 2 for more details (a copy is included in the LICENSE file that
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    12
.\" accompanied this code).
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    13
.\"
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    14
.\" You should have received a copy of the GNU General Public License version
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    15
.\" 2 along with this work; if not, write to the Free Software Foundation,
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    16
.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    17
.\"
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    18
.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    19
.\" or visit www.oracle.com if you need additional information or have any
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    20
.\" questions.
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    21
.\"
55140
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    22
.\" Automatically generated by Pandoc 2.3.1
21743
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 14342
diff changeset
    23
.\"
55140
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    24
.TH "RMIREGISTRY" "1" "2018" "JDK 13" "JDK Commands"
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    25
.hy
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    26
.SH NAME
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    27
.PP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    28
rmiregistry \- create and start a remote object registry on the
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    29
specified port on the current host
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    30
.SH SYNOPSIS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    31
.PP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    32
\f[CB]rmiregistry\f[R] [\f[I]options\f[R]] [\f[I]port\f[R]]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    33
.TP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    34
.B \f[I]options\f[R]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    35
This represents the option for the \f[CB]rmiregistry\f[R] command.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    36
See \f[B]Options\f[R]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    37
.RS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    38
.RE
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    39
.TP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    40
.B \f[I]port\f[R]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    41
The number of a port on the current host at which to start the remote
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    42
object registry.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    43
.RS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    44
.RE
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    45
.SH DESCRIPTION
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    46
.PP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    47
The \f[CB]rmiregistry\f[R] command creates and starts a remote object
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    48
registry on the specified port on the current host.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    49
If the port is omitted, then the registry is started on port 1099.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    50
The \f[CB]rmiregistry\f[R] command produces no output and is typically run
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    51
in the background, for example:
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    52
.RS
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    53
.PP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    54
\f[CB]rmiregistry\ &\f[R]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    55
.RE
21743
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 14342
diff changeset
    56
.PP
55140
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    57
A remote object registry is a bootstrap naming service that\[aq]s used
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    58
by RMI servers on the same host to bind remote objects to names.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    59
Clients on local and remote hosts can then look up remote objects and
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    60
make remote method invocations.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    61
.PP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    62
The registry is typically used to locate the first remote object on
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    63
which an application needs to call methods.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    64
That object then provides application\-specific support for finding
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    65
other objects.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    66
.PP
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    67
The methods of the \f[CB]java.rmi.registry.LocateRegistry\f[R] class are
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    68
used to get a registry operating on the local host or local host and
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    69
port.
21743
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 14342
diff changeset
    70
.PP
55140
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    71
The URL\-based methods of the \f[CB]java.rmi.Naming\f[R] class operate on
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    72
a registry and can be used to:
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    73
.IP \[bu] 2
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    74
Bind the specified name to a remote object
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    75
.IP \[bu] 2
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    76
Return an array of the names bound in the registry
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    77
.IP \[bu] 2
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    78
Return a reference, a stub, for the remote object associated with the
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    79
specified name
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    80
.IP \[bu] 2
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    81
Rebind the specified name to a new remote object
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    82
.IP \[bu] 2
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    83
Destroy the binding for the specified name that\[aq]s associated with a
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    84
remote object
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    85
.SH OPTIONS
21743
3d979da7bdf0 8029043: Update nroff files for JDK 8
rgallard
parents: 14342
diff changeset
    86
.TP
55140
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    87
.B \f[CB]\-J\f[R]\f[I]option\f[R]
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    88
Used with any Java option to pass the \f[I]option\f[R] following the
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    89
\f[CB]\-J\f[R] (no spaces between the \f[CB]\-J\f[R] and the option) to the
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    90
Java interpreter.
d4890c3721be 8225134: Update man-page files
jjg
parents: 52714
diff changeset
    91
.RS
31876
91b22707521a 8131105: Header Template for nroff man pages *.1 files contains errors
mfang
parents: 21743
diff changeset
    92
.RE