cg-help(1)

1CG-HELP(1)                                                          CG-HELP(1)
2
3
4

NAME

6       cg-help - show help for cogito commands
7

SYNOPSIS

9       cg-help [-c] [cg-COMMAND | COMMAND]
10
11

DESCRIPTION

13       Takes an optional argument describing the command to show the help for.
14       The command can be specified either as COMMAND or cg-COMMAND. If the
15       argument is left out an overview of all the Cogito commands will be
16       shown.
17
18       Note, short help for a command is also available by passing --help or
19       -h to the command. The complete command manual is shown when passing
20       --long-help (and is the same as doing "cg-help command").
21
22

OPTIONS

24       -c     Colorize the output. You can customize the colors using the
25              $CG_COLORS environment variable (see below).
26
27       -h, --help
28              Print usage summary.
29
30       --long-help
31              Print user manual. The same as found in cg-help(1).
32

ENVIRONMENT VARIABLES

34       PAGER  The pager to display log information in, defaults to less.
35
36       PAGER_FLAGS
37              Flags to pass to the pager.
38
39       CG_COLORS
40              Colon-separated list of name=color pairs, where name is one of
41              helpcopy, helpusage, helpsection, helplitem, helpcgcmd,
42              helpcode, helpempth, default, and value is an ECMA-48 SGR
43              sequence (see e.g. console_codes(4)).
44
45       CG_COLORS_AUTO
46              Even if -c was passed or specified in ~/.cgrc, if this option is
47              set, use colors only when the output is a terminal and it
48              supports colors.
49
50       CG_LESS
51              This is what the $LESS environment variable value will be set to
52              before invoking $PAGER. It defaults to $LESS concatenated with
53              the R flag to allow displaying of colorized output.
54

CONFIGURATION VARIABLES

56       The following GIT configuration file variables are recognized:
57
58
59       help.usecolor
60              If enabled, colorify the output like with -c if the output is a
61              terminal.
62

COPYRIGHT

64       Copyright © Petr Baudis, 2005
65
66