glassfish
  1. glassfish
  2. GLASSFISH-17605

asadmin manual page is hardcoded for GlassFish

    Details

    • Type: Bug Bug
    • Status: Open
    • Priority: Major Major
    • Resolution: Unresolved
    • Affects Version/s: 4.0
    • Fix Version/s: 4.1.1
    • Component/s: docs
    • Labels:
      None

      Description

      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.

        Activity

        Hide
        Tom Mueller added a comment -

        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.

        Show
        Tom Mueller added a comment - 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.

          People

          • Assignee:
            Paul Davies
            Reporter:
            Tom Mueller
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated: