[GLASSFISH-17605] asadmin manual page is hardcoded for GlassFish Created: 03/Nov/11  Updated: 21/Sep/15

Status: Open
Project: glassfish
Component/s: docs
Affects Version/s: 4.0
Fix Version/s: 4.1.1

Type: Bug Priority: Major
Reporter: Tom Mueller Assignee: Paul Davies
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Tags: ee7ri_cleanup_deferred, nucleus-cleanup


The administrative CLI for nucleus, known as asadmin, is actually a generic tool that is the interface for any nucleus-based product. Within nucleus, it is called "nadmin" for nucleus admin. However, it is intended to be "skinned" for each product based on nucleus, e.g., asadmin for the app server.

The output of nadmin -? is the manual page for the command. This manual page has "asadmin" embedded in it with references to Oracle GlassFish Server, i.e., it is branded for the GF product. This needs to either be made generic or the content of the manual page has to vary depending on the product that is using it.

This bug is for figuring out how to solve this problem.

Comment by Tom Mueller [ 14/Mar/12 ]

Other asadmin-related strings (besides command name and product name) in the manual page are:

  • Environment variable names such as AS_ADMIN_TERSE, AS_ADMIN_HOST
  • Prefixes for passwords, e.g., AS_ADMIN_PASSWORD. Note that this may effect the documentation for subcommands too, if they state the name of an environment variable that can be used to pass a value. For example, consider create-file-user and AS_ADMIN_USERPASSWORD.

Note: the documentation for the -W option in the asadmin manual page references configure-jms-cluster command which is not in nucleus. Also, the examples use create-jdbc-connection-pool.

Generated at Fri Oct 09 05:27:50 UTC 2015 using JIRA 6.2.3#6260-sha1:63ef1d6dac3f4f4d7db4c1effd405ba38ccdc558.