[go: up one dir, main page]

File: utoprc.5

package info (click to toggle)
utop 1.19.3-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 692 kB
  • ctags: 1,166
  • sloc: ml: 10,046; lisp: 877; makefile: 89; sh: 20
file content (162 lines) | stat: -rw-r--r-- 3,109 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
\" utoprc.5
\" --------
\" Copyright : (c) 2011, Jeremie Dimino <jeremie@dimino.org>
\" Licence   : BSD3
\"
\" This file is a part of utop.

.TH UTOPRC 5 "August 2011"

.SH NAME
utoprc \- Configuration file of utop

.SH SYNOPSIS
.B ~/.utoprc

.SH DESCRIPTION

This manual page describes the format of the
.I ~/.utoprc
file. This is a text file which contains the configuration of
utop. Comments start with a '!' and empty lines are
ignored. Configuration lines are of the form:

        <wildcard>: <value>

.I <wildcard>
may contains the '*' star character. In that case any key which match
the pattern is given the value after the colon.

The boolean key
.I autoload
can be set to
.I false
to disable the autoloading of files in
.I $OCAML_TOPLEVEL_PATH/autoload
at startup.

The key
.I external-editor
can be set to a command line. It is used to edit the input when
pressing C-x C-e. It defaults to the contents of the
.I EDITOR
environment variable.

The key
.I profile
may have the value
.I dark
or
.I light.
This is the same as calling
.I UTop.set_profile
in
.I ~/.ocamlinit.

The following style keys are used by utop:

        * identifier
        * module
        * comment
        * doc
        * constant
        * keyword
        * symbol
        * string
        * char
        * quotation
        * error
        * directive
        * parenthesis
        * blanks

For each of these keys, the following sub-keys are used:

        * key.foreground
        * key.background
        * key.bold
        * key.underline
        * key.reverse
        * key.blink

.I key.foreground
and
.I key.background
are colors, and the others are booleans. Colors may be one of the
standard terminal colors:

        * black
        * red
        * green
        * yellow
        * blue
        * magenta
        * cyan
        * white
        * light-black
        * light-red
        * light-green
        * light-yellow
        * light-blue
        * light-magenta
        * light-cyan
        * light-white

or X11 colors, prefixed with "x-". For example:

        identifier.foreground:  x-goldenrod

Colors can also be given by their RGB components, written #RRGGBB. For
example:

        identifier.foreground:  #5fbf7f

utop will choose the nearest color of the terminal when specifying a
X11 color or a color given by its RGB components. If you are using
gnome-terminal or konsole, you can enable 256 colors by setting the
environment variable TERM to "xterm-256color".

.SH FILES
.I ~/.utoprc

.SH EXAMPLE
profile:                  dark
.RS
.RE
identifier.foreground:    none
.RS
.RE
comment.foreground:       x-chocolate1
.RS
.RE
doc.foreground:           x-light-salmon
.RS
.RE
constant.foreground:      x-aquamarine
.RS
.RE
keyword.foreground:       x-cyan1
.RS
.RE
symbol.foreground:        x-cyan1
.RS
.RE
string.foreground:        x-light-salmon
.RS
.RE
char.foreground:          x-light-salmon
.RS
.RE
quotation.foreground:     x-purple
.RS
.RE
error.foreground:         x-red
.RS
.RE
parenthesis.background:   blue

.SH AUTHOR
Jérémie Dimino <jeremie@dimino.org>

.SH "SEE ALSO"
.BR utop (1).