Class ManMultiPageGlobalUsageGenerator<T>

    • Field Detail

      • baseDirectory

        private java.io.File baseDirectory
    • Constructor Detail

      • ManMultiPageGlobalUsageGenerator

        public ManMultiPageGlobalUsageGenerator()
      • ManMultiPageGlobalUsageGenerator

        public ManMultiPageGlobalUsageGenerator​(int manSection)
      • ManMultiPageGlobalUsageGenerator

        public ManMultiPageGlobalUsageGenerator​(int manSection,
                                                boolean includeHidden)
      • ManMultiPageGlobalUsageGenerator

        public ManMultiPageGlobalUsageGenerator​(int manSection,
                                                boolean includeHidden,
                                                java.io.File baseDirectory)
      • ManMultiPageGlobalUsageGenerator

        protected ManMultiPageGlobalUsageGenerator​(int manSection,
                                                   boolean includeHidden,
                                                   CommandUsageGenerator commandUsageGenerator,
                                                   java.io.File baseDir)
    • Method Detail

      • outputCommandUsages

        protected void outputCommandUsages​(java.io.OutputStream output,
                                           TroffPrinter printer,
                                           GlobalMetadata<T> global)
                                    throws java.io.IOException
        Description copied from class: ManGlobalUsageGenerator
        Outputs the command usages for all groups
        Overrides:
        outputCommandUsages in class ManGlobalUsageGenerator<T>
        Parameters:
        output - Output stream
        printer - Writer
        global - Global meta-data
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output
      • outputGroupCommandUsages

        protected void outputGroupCommandUsages​(java.io.OutputStream output,
                                                TroffPrinter printer,
                                                GlobalMetadata<T> global,
                                                java.util.List<CommandGroupMetadata> groups)
                                         throws java.io.IOException
        Description copied from class: ManGlobalUsageGenerator
        Outputs the command usages for the commands in the given group
        Overrides:
        outputGroupCommandUsages in class ManGlobalUsageGenerator<T>
        Parameters:
        output - Output
        printer - Writer
        global - Global Meta-data
        groups - Groups Meta-data
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output
      • outputReferenceToSuite

        protected void outputReferenceToSuite​(TroffPrinter printer,
                                              GlobalMetadata<T> global)
                                       throws java.io.IOException
        Throws:
        java.io.IOException
      • createCommandFile

        protected java.io.FileOutputStream createCommandFile​(GlobalMetadata<T> global,
                                                             java.lang.String[] groupNames,
                                                             CommandMetadata command)
                                                      throws java.io.FileNotFoundException
        Throws:
        java.io.FileNotFoundException
      • outputDefaultGroupCommandUsages

        protected void outputDefaultGroupCommandUsages​(java.io.OutputStream output,
                                                       TroffPrinter printer,
                                                       GlobalMetadata<T> global)
                                                throws java.io.IOException
        Description copied from class: ManGlobalUsageGenerator
        Outputs the command usages for the commands in the default group
        Overrides:
        outputDefaultGroupCommandUsages in class ManGlobalUsageGenerator<T>
        Parameters:
        output - Output
        printer - Writer
        global - Global meta-data
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output