Uploaded image for project: 'Couchbase Server'
  1. Couchbase Server
  2. MB-27971

Add man and whatis info to tools

    XMLWordPrintable

Details

    • Improvement
    • Status: Open
    • Minor
    • Resolution: Unresolved
    • 5.0.1
    • feature-backlog
    • installer

    Description

      All of our tools having manuals with --help, which is ok, 
      But I think, as an improvement, we should also use the standard of man and whatis so it would be natural to users to access documentation.

       

      Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

          pvarley Patrick Varley added a comment - - edited

          We do have man pages which can be read using man:

          man -M /opt/couchbase/share/man cbbackupmgr
          

          The problem is man does not know where to look for the Couchbase manual pages. One suggested solution is to update man.config, which should be done at install, rpm upgrade and uninstall times. There might be better approaches to take which we should investigate further. As this is more of a system integration issue I have change the component to installer.

          In the mean time the user could set MANPATH in the shell profile.

          MANPATH=/opt/couchbase/share/man:$MANPATH man cbbackupmgr
          

          pvarley Patrick Varley added a comment - - edited We do have man pages which can be read using man : man -M /opt/couchbase/share/man cbbackupmgr The problem is man does not know where to look for the Couchbase manual pages. One suggested solution is to update man.config , which should be done at install, rpm upgrade and uninstall times. There might be better approaches to take which we should investigate further. As this is more of a system integration issue I have change the component to installer. In the mean time the user could set MANPATH in the shell profile. MANPATH=/opt/couchbase/share/man:$MANPATH man cbbackupmgr
          roi.katz Roi Katz added a comment -

          that is a nice workaround.
          we sure need to add it while installing Couchbase.

          roi.katz Roi Katz added a comment - that is a nice workaround. we sure need to add it while installing Couchbase.
          roi.katz Roi Katz added a comment -

          Patrick Varley did we added it to our installation since? or are we planning to?

          roi.katz Roi Katz added a comment - Patrick Varley did we added it to our installation since? or are we planning to?

          People

            mikew Mike Wiederhold [X] (Inactive)
            roi.katz Roi Katz
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:

              Gerrit Reviews

                There are no open Gerrit changes

                PagerDuty