Class ManUsageHelper

    • Constructor Detail

      • ManUsageHelper

        public ManUsageHelper​(java.util.Comparator<? super OptionMetadata> optionComparator,
                              boolean includeHidden)
    • Method Detail

      • outputOptions

        public int outputOptions​(TroffPrinter printer,
                                 java.util.List<OptionMetadata> options,
                                 boolean endList)
                          throws java.io.IOException
        Throws:
        java.io.IOException
      • outputArguments

        public <T> void outputArguments​(TroffPrinter printer,
                                        ArgumentsMetadata arguments,
                                        boolean startList,
                                        ParserMetadata<T> parserConfig)
                                 throws java.io.IOException
        Throws:
        java.io.IOException
      • outputOptionRestriction

        protected void outputOptionRestriction​(TroffPrinter printer,
                                               OptionMetadata option,
                                               OptionRestriction restriction,
                                               HelpHint hint)
                                        throws java.io.IOException
        Outputs documentation about a restriction on an option
        Parameters:
        printer - Troff printer
        option - Option meta-data
        restriction - Restriction
        hint - Help hint
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output
      • outputArgumentsRestriction

        protected void outputArgumentsRestriction​(TroffPrinter printer,
                                                  ArgumentsMetadata arguments,
                                                  ArgumentsRestriction restriction,
                                                  HelpHint hint)
                                           throws java.io.IOException
        Outputs documentation about a restriction on an option
        Parameters:
        printer - Troff Printer
        arguments - Arguments meta-data
        restriction - Restriction
        hint - Help hint
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output
      • outputHelpSection

        public void outputHelpSection​(TroffPrinter printer,
                                      HelpSection section)
                               throws java.io.IOException
        Outputs a help section
        Parameters:
        printer - Troff printer
        section - Help section
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output