1
2
3
4
5
6
7
8UTOPRC(5)                     File Formats Manual                    UTOPRC(5)
9
10
11

NAME

13       utoprc - Configuration file of utop
14
15

SYNOPSIS

17       ~/.utoprc
18
19

DESCRIPTION

21       This  manual page describes the format of the ~/.utoprc file. This is a
22       text file which contains the configuration of utop. Comments start with
23       a '!' and empty lines are ignored. Configuration lines are of the form:
24
25               <wildcard>: <value>
26
27       <wildcard>  may  contains  the '*' star character. In that case any key
28       which match the pattern is given the value after the colon.
29
30       The boolean key autoload can be set to false to disable the autoloading
31       of files in $OCAML_TOPLEVEL_PATH/autoload at startup.
32
33       The  key  external-editor  can  be set to a command line. It is used to
34       edit the input when pressing C-x C-e. It defaults to  the  contents  of
35       the EDITOR environment variable.
36
37       The  key profile may have the value dark or light.  This is the same as
38       calling UTop.set_profile in ~/.ocamlinit.
39
40       The following style keys are used by utop:
41
42               * identifier
43               * module
44               * comment
45               * doc
46               * constant
47               * keyword
48               * symbol
49               * string
50               * char
51               * quotation
52               * error
53               * directive
54               * parenthesis
55               * blanks
56
57       For each of these keys, the following sub-keys are used:
58
59               * key.foreground
60               * key.background
61               * key.bold
62               * key.underline
63               * key.reverse
64               * key.blink
65
66       key.foreground and key.background are colors, and the others are  bool‐
67       eans. Colors may be one of the standard terminal colors:
68
69               * black
70               * red
71               * green
72               * yellow
73               * blue
74               * magenta
75               * cyan
76               * white
77               * light-black
78               * light-red
79               * light-green
80               * light-yellow
81               * light-blue
82               * light-magenta
83               * light-cyan
84               * light-white
85
86       or X11 colors, prefixed with "x-". For example:
87
88               identifier.foreground:  x-goldenrod
89
90       Colors  can also be given by their RGB components, written #RRGGBB. For
91       example:
92
93               identifier.foreground:  #5fbf7f
94
95       utop will choose the nearest color of the terminal  when  specifying  a
96       X11  color  or  a  color  given by its RGB components. If you are using
97       gnome-terminal or konsole, you can enable 256  colors  by  setting  the
98       environment variable TERM to "xterm-256color".
99
100

FILES

102       ~/.utoprc
103
104

EXAMPLE

106       profile:                  dark
107       identifier.foreground:    none
108       comment.foreground:       x-chocolate1
109       doc.foreground:           x-light-salmon
110       constant.foreground:      x-aquamarine
111       keyword.foreground:       x-cyan1
112       symbol.foreground:        x-cyan1
113       string.foreground:        x-light-salmon
114       char.foreground:          x-light-salmon
115       quotation.foreground:     x-purple
116       error.foreground:         x-red
117       parenthesis.background:   blue
118
119

AUTHOR

121       Jérémie Dimino <jeremie@dimino.org>
122
123

SEE ALSO

125       utop(1).
126
127
128
129                                  August 2011                        UTOPRC(5)