man_examples_test.go

Documentation: github.com/spf13/cobra/doc

     1  // Copyright 2013-2023 The Cobra Authors
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package doc_test
    16  
    17  import (
    18  	"bytes"
    19  	"fmt"
    20  
    21  	"github.com/spf13/cobra"
    22  	"github.com/spf13/cobra/doc"
    23  )
    24  
    25  func ExampleGenManTree() {
    26  	cmd := &cobra.Command{
    27  		Use:   "test",
    28  		Short: "my test program",
    29  	}
    30  	header := &doc.GenManHeader{
    31  		Title:   "MINE",
    32  		Section: "3",
    33  	}
    34  	cobra.CheckErr(doc.GenManTree(cmd, header, "/tmp"))
    35  }
    36  
    37  func ExampleGenMan() {
    38  	cmd := &cobra.Command{
    39  		Use:   "test",
    40  		Short: "my test program",
    41  	}
    42  	header := &doc.GenManHeader{
    43  		Title:   "MINE",
    44  		Section: "3",
    45  	}
    46  	out := new(bytes.Buffer)
    47  	cobra.CheckErr(doc.GenMan(cmd, header, out))
    48  	fmt.Print(out.String())
    49  }
    50
View as plain text