GlassFish - World's first Java EE 7 Application Server


<h1>Administration CLI Documentation Plan</h1>

People and Roles

Name Role Location Time Zone Email
Paul Davies Documentation Feature Owner Santa Clara, CA, USA US/Pacific pauldavies@dev.java.net
Documentation Team Additional Writers     docs@glassfish.java.net
Julie Bettis Editor Broomfield, CO, USA US/Mountain  
Kedar Mhaswade Software Engineer Santa Clara, CA, USA US/Pacific km@dev.java.net
Lloyd Chambers Software Engineer Santa Clara, CA, USA US/Pacific @dev.java.net
Bill Shannon Software Engineer Santa Clara, CA, USA US/Pacific @dev.java.net
Sankar Neelakandan QA Engineer Santa Clara, CA, USA US/Pacific sankarpn@dev.java.net

Audience

    • Primary:* System administrators who are setting up or maintaining GlassFish Application Server.
    • Secondary:* Software application developers who are using GlassFish Application Server for testing applications under development.

Summary of the Feature From a User's Perspective

This feature affects how users will administer GlassFish Application Server from the command line.

Availability

This feature is available all distributions of GlassFish Application Server.

Statement of Work

This section describes in detail for each document the work that is required by the introduction of the feature, such as changes, addition of new material, relocation of existing material, and removal of existing material.

Documentation Impact:

  • None
  • Minor
  • Moderate
  • Major
  • New

Note - If a document is task based (as opposed to reference), the changes should be determined from the user task analysis for the feature.

Changes to Books

Administration Guide Changes

Section Documentation Impact Writer Reviewers Description of Change
Command-Line Utility for Administration (asadmin) . Moderate Paul Kedar Mhasawade
Lloyd Chambers
Bill Shannon
Sankar Neelakandan 		Add these subsections:
  • Format ofasadmin Commands
    Explain that the general format of asadmin commands is: asadmin asadmin-utility-options subcommand subcommand-options operands
    Cross-refer to the asadmin(1M) man page for the full syntax.
  • Subcommands of theasadminUtility
    Explain that subcommand specifies the operation or task that the user is performing.
    Cross-refer to the Reference Manual for the full list of asadmin utility subcommands.
  • Options of theasadminUtility
    Explain that:
    • These options control the behavior of the asadmin utility, not the subcommand.
    • These options must precede the subcommand.
    • For compatibility with earlier releases, these options are permitted after the subcommand, but such syntax is deprecated.
  • Options of asadmin Subcommands
    Explan that:
    • Subcommand options control the behavior of the the subcommand, not the asadmin utility.
    • Subcommand options must follow the subcommand.
    • A subcommand option may have the same name as an asadmin utility option, but the effect of the two options are different.
  • Operands of asadmin Subcommands
    Explain that:
    • Operands specify the objects on which the subcommand is to act.
    • Operands must follow the subcommand options.
All examples Moderate Dixie See Man Pages Document Plan . Rewrite in multimode.
Remove all asadmin utility options.

Reference Manual Changes

Section Documentation Impact Writer Reviewers Description of Change
Section 1: Administration Commands Minor Paul Kedar Mhasawade Lloyd Chambers Bill Shannon Sankar Neelakandan Change the title of this section to: Section 1: asadmin Utility Subcommands

Changes to Online Help

None. The Administration Console is not affected by this feature.

Changes to Man Pages

Man Page Name and Section Documentation Impact Writer Reviewers Description of Change
asadmin(1M) Moderate Paul Kedar Mhasawade
Lloyd Chambers
Bill Shannon
Sankar Neelakandan 		Update or add the following sections:
  • Synopsis
    • List all asadmin utility options before subcommand.
    • Reword option placeholders to emphasize that they apply to the subcommand.
  • Description
    • Change Options for the asadmin Utility to asadmin Utility Options and Subcommand Options.
    • Explain the differences between asadmin utility options and subcommand options.
    • Change Operands of the asadmin Utility to Operands of asadmin Subcommands.
    • Remove the entire subsection Required Options for Remote asadmin Subcommands.
    • Move the content of Password File Options to a description of the --passwordfile option in the Options section.
  • Options
    Add this section, which is to contain an explanation of each asadmin utility option.
  • Examples
    Add examples that show how to specify asadmin utility options.
All administration man pages Major See Man Pages Document Plan See Man Pages Document Plan Update or add the following sections:
  • Header text
    • Change Administration Commands to asadmin Utility Subcommands.
    • Update the last updated date and, if necessary, the copyright year.
  • Synopsis
    Remove all asadmin utility options.
  • Options
    Remove all asadmin utility options.
  • Examples
    Remove all asadmin utility options.
    Editorial enhancement: Change title to something more descriptive than "Using the command command".

Sample changed man page (PDF)

The asadmin utility options are as follows:

  • --host -h
  • --port -p
  • --user -u
  • --passwordfile -W
  • --secure -s
  • --interactive -D
  • --terse -t
  • --echo -e

Review Schedule

The review schedule for the documentation items that are affected by this feature is provided in the following table.

Item First Draft Start Date First Draft End Date Second Draft Start Date Second Draft End Date Final Version End Date Final Version End Date
Command-Line Utility for Administration (asadmin) 28 July, 2009 7 August, 2009        
asadmin(1M) man page 28 July, 2009 7 August, 2009        
             

Reviewers are listed in the Statement of Work.

Related Information

Email aliases:

  • []
  • []
  • []

Attachments:
create-javamail-resource.1.pdf (application/pdf)