Class ManCommandUsageGenerator

java.lang.Object
com.github.rvesse.airline.help.common.AbstractUsageGenerator
com.github.rvesse.airline.help.common.AbstractCommandUsageGenerator
com.github.rvesse.airline.help.man.ManCommandUsageGenerator
All Implemented Interfaces:
CommandUsageGenerator
public class ManCommandUsageGenerator extends AbstractCommandUsageGenerator
A command usage generator which generates help in man page (Troff) format

  • Field Details

    • manSection

      private final int manSection

    • helper

      private final ManUsageHelper helper

  • Constructor Details

    • ManCommandUsageGenerator

      public ManCommandUsageGenerator()

    • ManCommandUsageGenerator

      public ManCommandUsageGenerator(int manSection, boolean includeHidden)
      Creates a new man page usage generator
      Parameters:
      manSection - Man section to which this command belongs, use constants from ManSections
      includeHidden - Whether to include hidden items in the help output

  • Method Details

    • createHelper

      protected ManUsageHelper createHelper(boolean includeHidden)

    • usage

      public <T> void usage(String programName, String[] groupNames, String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, OutputStream output) throws IOException
      Description copied from interface: CommandUsageGenerator
      Generate the help and output it to the stream
      Type Parameters:
      T - Command type
      Parameters:
      programName - Program Name
      groupNames - Group Name(s)
      commandName - Command Name
      command - Command Metadata
      parserConfig - Parser Configuration, if null is passed then the parser configuration is automatically determined based on the command class for which we are producing help
      output - Stream to output to
      Throws:
      IOException - Thrown if there is a problem generating usage output

    • outputOptions

      protected <T> void outputOptions(TroffPrinter printer, CommandMetadata command, List<OptionMetadata> options, ParserMetadata<T> parserConfig) throws IOException
      Outputs a documentation section detailing the options and their usages
      Type Parameters:
      T - Command type
      Parameters:
      printer - Troff Printer
      command - Command
      options - Option meta-data
      parserConfig - Parser configuration
      Throws:
      IOException - Thrown if there is a problem generating usage output

    • outputSynopsis

      protected List<OptionMetadata> outputSynopsis(TroffPrinter printer, String programName, String[] groupNames, String commandName, CommandMetadata command) throws IOException
      Outputs a synopsis section for the documentation showing how to use a command
      Parameters:
      printer - Troff printer
      programName - Program name
      groupNames - Group name(s)
      commandName - Command name
      command - Command
      Returns:
      List of all the available options (global, group and command)
      Throws:
      IOException - Thrown if there is a problem generating usage output

    • outputTitle

      protected void outputTitle(TroffPrinter printer, String programName, String[] groupNames, String commandName, CommandMetadata command) throws IOException
      Outputs a title section for the document
      Parameters:
      printer - Troff Printer
      programName - Program name
      groupNames - Group name(s)
      commandName - Command name
      command - Command meta-data
      Throws:
      IOException - Thrown if there is a problem generating usage output

    • getFullCommandName

      protected String getFullCommandName(String programName, String[] groupNames, String commandName) throws IOException
      Gets the full command name in man page syntax
      Parameters:
      programName - Program name
      groupNames - Group name(s)
      commandName - Command name
      Returns:
      Full command name
      Throws:
      IOException - Thrown if there is a problem generating usage output

    • toDescription

      protected String toDescription(OptionMetadata option)
      Overrides:
      toDescription in class AbstractUsageGenerator