About This Guide


This manual describes how to administer iPlanet^TM Portal Server: Instant Collaboration Pack (also referred to as iPlanet^TM Instant Messaging Server) and its accompanying software components. For the most recent information about known problems with this release, see the iPlanet Instant Messaging Server release notes listed online at:

http://docs.iplanet.com/docs/manuals/portal.html

This preface contains the following sections:

• Who Should Read This Book

• What You Need to Know

• How This Book is Organized

• Conventions Used in This Manual

Who Should Read This Book

---

You should read this manual if you are responsible for deploying and administering iPlanet Instant Messaging Server at your site.

What You Need to Know

---

This book assumes that you are responsible for configuring, administering, and maintaining iPlanet Instant Messaging Server and that you have a general understanding of the following:

• The Internet and the World Wide Web

• iPlanet Portal Server

• iPlanet Web Server

• iPlanet Directory Server

• iPlanet Delegated Administrator

How This Book is Organized

---

This book contains the following chapters and appendices:

• About This Guide (this chapter)

• Chapter 1 "Introduction to iPlanet Instant Messaging Server"

  This chapter describes iPlanet Instant Messaging Server components, architecture, and configurations.

• Chapter 2 "Administering iPlanet Instant Messaging Server and Multiplexor"

  This chapter describes how to administer iPlanet Instant Messaging server and multiplexor.

• Chapter 3 "Managing iPlanet Instant Messenger"

  This chapter describes how to customize and administer the iPlanet Instant Messenger client.

• Appendix A "iPlanet Instant Messaging Server Configuration Parameters"

  This appendix describes the settings you can configure for iPlanet Instant Messaging Server.

• Appendix B "iPlanet Instant Messaging Server Reference"

  This appendix describes the iimadmin command used to administer iPlanet Instant Messaging Server, and the iimipsadmin script for iPlanet Portal Server deployments.

Conventions Used in This Manual

---

Monospaced Font

Monospaced font is used for any text that appears on the computer screen or text that you should type. It is also used for file names, distinguished names, functions, and examples.

Bold Monospaced Font

Bold monospaced font is used to represent text within a code example that you should type. For example, you might see something like this:

./setup
Copyright (c) 2001 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Sun, Sun Microsystems, the Sun logo, Java, Solaris and iPlanet are trademarks or registered trademarks of Sun Microsystems, Inc.in the U.S. and other countries. Federal Acquisitions: Commercial Software - Government Users Subject to Standard License Terms and Conditions.

Copyright (c) 2001 Sun Microsystems, Inc. Tous droits réservés. Distribué par des licences qui en restreignent l'utilisation. Sun, Sun Microsystems, le logo Sun, Java, Solaris et iPlanet sont des marques de fabrique ou des marques déposées de Sun Microsystems, Inc. aux Etats-Unis et dans d'autres pays.

===================================================================

Verifying permissions
Verifying java available
Found java (/usr/j2se/bin/java) version (1.3.0) in the system.
Verifying installation components available
Verifying directories available
Verifying files available
Starting install wizard in graphical mode

In this example, ./setup is what you would type from the command line and the rest is what would appear as a result.

Italicized Font

Italicized font is used to represent text that you enter using information that is unique to your installation (for example, variables). It is used for server paths and names and account IDs.

Square or Straight Brackets

Square (or straight) brackets [] are used to enclose optional parameters. For example, in this document you will see the usage for the iimadmin command described as follows:

iimadmin [options] [action] [component]

The presence of [options], [arguments], and [component] indicates that there are optional parameters that may be added to the iimadmin command.

Command-Line Prompts

Command-line prompts (for example, % for a C-Shell, or $ for a Korn or Bourne shell) are not displayed in the examples. Depending on which operating system environment you are using, you will see a variety of different command-line prompts. However, you should enter the command as it appears in the document unless specifically noted otherwise.