src/java.rmi/share/man/rmiregistry.1
changeset 55140 d4890c3721be
parent 52714 2e52aa822c57
equal deleted inserted replaced
55139:3ea18959a349 55140:d4890c3721be
     1 '\" t
     1 .\" Copyright (c) 1994, 2019, Oracle and/or its affiliates. All rights reserved.
     2 .\" Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
       
     3 .\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     2 .\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     4 .\"
     3 .\"
     5 .\" This code is free software; you can redistribute it and/or modify it
     4 .\" This code is free software; you can redistribute it and/or modify it
     6 .\" under the terms of the GNU General Public License version 2 only, as
     5 .\" under the terms of the GNU General Public License version 2 only, as
     7 .\" published by the Free Software Foundation.
     6 .\" published by the Free Software Foundation.
    18 .\"
    17 .\"
    19 .\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    18 .\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    20 .\" or visit www.oracle.com if you need additional information or have any
    19 .\" or visit www.oracle.com if you need additional information or have any
    21 .\" questions.
    20 .\" questions.
    22 .\"
    21 .\"
    23 .\"     Arch: generic
    22 .\" Automatically generated by Pandoc 2.3.1
    24 .\"     Software: JDK 8
       
    25 .\"     Date: 21 November 2013
       
    26 .\"     SectDesc: Remote Method Invocation (RMI) Tools
       
    27 .\"     Title: rmiregistry.1
       
    28 .\"
    23 .\"
    29 .if n .pl 99999
    24 .TH "RMIREGISTRY" "1" "2018" "JDK 13" "JDK Commands"
    30 .TH rmiregistry 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools"
    25 .hy
    31 .\" -----------------------------------------------------------------
    26 .SH NAME
    32 .\" * Define some portability stuff
       
    33 .\" -----------------------------------------------------------------
       
    34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
       
    35 .\" http://bugs.debian.org/507673
       
    36 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
       
    37 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
       
    38 .ie \n(.g .ds Aq \(aq
       
    39 .el       .ds Aq '
       
    40 .\" -----------------------------------------------------------------
       
    41 .\" * set default formatting
       
    42 .\" -----------------------------------------------------------------
       
    43 .\" disable hyphenation
       
    44 .nh
       
    45 .\" disable justification (adjust text to left margin only)
       
    46 .ad l
       
    47 .\" -----------------------------------------------------------------
       
    48 .\" * MAIN CONTENT STARTS HERE *
       
    49 .\" -----------------------------------------------------------------
       
    50 
       
    51 .SH NAME    
       
    52 rmiregistry \- Starts a remote object registry on the specified port on the current host\&.
       
    53 .SH SYNOPSIS    
       
    54 .sp     
       
    55 .nf     
       
    56 
       
    57 \fBrmiregistry\fR [ \fIport\fR ]
       
    58 .fi     
       
    59 .sp     
       
    60 .TP     
       
    61 \fIport\fR
       
    62 The number of a \f3port\fR on the current host at which to start the remote object registry\&.
       
    63 .SH DESCRIPTION    
       
    64 The \f3rmiregistry\fR command creates and starts a remote object registry on the specified port on the current host\&. If the port is omitted, then the registry is started on port 1099\&. The \f3rmiregistry\fR command produces no output and is typically run in the background, for example:
       
    65 .sp     
       
    66 .nf     
       
    67 \f3rmiregistry &\fP
       
    68 .fi     
       
    69 .nf     
       
    70 \f3\fP
       
    71 .fi     
       
    72 .sp     
       
    73 A remote object registry is a bootstrap naming service that is used by RMI servers on the same host to bind remote objects to names\&. Clients on local and remote hosts can then look up remote objects and make remote method invocations\&.
       
    74 .PP
    27 .PP
    75 The registry is typically used to locate the first remote object on which an application needs to call methods\&. That object then provides application-specific support for finding other objects\&.
    28 rmiregistry \- create and start a remote object registry on the
       
    29 specified port on the current host
       
    30 .SH SYNOPSIS
    76 .PP
    31 .PP
    77 The methods of the \f3java\&.rmi\&.registry\&.LocateRegistry\fR class are used to get a registry operating on the local host or local host and port\&.
    32 \f[CB]rmiregistry\f[R] [\f[I]options\f[R]] [\f[I]port\f[R]]
       
    33 .TP
       
    34 .B \f[I]options\f[R]
       
    35 This represents the option for the \f[CB]rmiregistry\f[R] command.
       
    36 See \f[B]Options\f[R]
       
    37 .RS
       
    38 .RE
       
    39 .TP
       
    40 .B \f[I]port\f[R]
       
    41 The number of a port on the current host at which to start the remote
       
    42 object registry.
       
    43 .RS
       
    44 .RE
       
    45 .SH DESCRIPTION
    78 .PP
    46 .PP
    79 The URL-based methods of the \f3java\&.rmi\&.Naming\fR class operate on a registry and can be used to look up a remote object on any host and on the local host\&. Bind a simple name (string) to a remote object, rebind a new name to a remote object (overriding the old binding), unbind a remote object, and list the URL bound in the registry\&.
    47 The \f[CB]rmiregistry\f[R] command creates and starts a remote object
    80 .SH OPTIONS    
    48 registry on the specified port on the current host.
       
    49 If the port is omitted, then the registry is started on port 1099.
       
    50 The \f[CB]rmiregistry\f[R] command produces no output and is typically run
       
    51 in the background, for example:
       
    52 .RS
       
    53 .PP
       
    54 \f[CB]rmiregistry\ &\f[R]
       
    55 .RE
       
    56 .PP
       
    57 A remote object registry is a bootstrap naming service that\[aq]s used
       
    58 by RMI servers on the same host to bind remote objects to names.
       
    59 Clients on local and remote hosts can then look up remote objects and
       
    60 make remote method invocations.
       
    61 .PP
       
    62 The registry is typically used to locate the first remote object on
       
    63 which an application needs to call methods.
       
    64 That object then provides application\-specific support for finding
       
    65 other objects.
       
    66 .PP
       
    67 The methods of the \f[CB]java.rmi.registry.LocateRegistry\f[R] class are
       
    68 used to get a registry operating on the local host or local host and
       
    69 port.
       
    70 .PP
       
    71 The URL\-based methods of the \f[CB]java.rmi.Naming\f[R] class operate on
       
    72 a registry and can be used to:
       
    73 .IP \[bu] 2
       
    74 Bind the specified name to a remote object
       
    75 .IP \[bu] 2
       
    76 Return an array of the names bound in the registry
       
    77 .IP \[bu] 2
       
    78 Return a reference, a stub, for the remote object associated with the
       
    79 specified name
       
    80 .IP \[bu] 2
       
    81 Rebind the specified name to a new remote object
       
    82 .IP \[bu] 2
       
    83 Destroy the binding for the specified name that\[aq]s associated with a
       
    84 remote object
       
    85 .SH OPTIONS
    81 .TP
    86 .TP
    82 -J
    87 .B \f[CB]\-J\f[R]\f[I]option\f[R]
    83 .br
    88 Used with any Java option to pass the \f[I]option\f[R] following the
    84 Used with any Java option to pass the option following the \f3-J\fR (no spaces between the \f3-J\fR and the option) to the Java interpreter\&.
    89 \f[CB]\-J\f[R] (no spaces between the \f[CB]\-J\f[R] and the option) to the
    85 .SH SEE\ ALSO    
    90 Java interpreter.
    86 .TP 0.2i    
    91 .RS
    87 \(bu
       
    88 java(1)
       
    89 .TP 0.2i    
       
    90 \(bu
       
    91 \f3java\&.rmi\&.registry\&.LocateRegistry\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/registry/LocateRegistry\&.html
       
    92 .TP 0.2i    
       
    93 \(bu
       
    94 \f3java\&.rmi\&.Naming class description\fR at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/Naming\&.html
       
    95 .RE
    92 .RE
    96 .br
       
    97 'pl 8.5i
       
    98 'bp