UTOPRC(5)

πŸ“¦
version 2.17.0 Β· 2 versions
, in debian trixie, fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ’– UTOPRC β€” bestie, it's the config file for utop (section 5 of the File Formats Manual, iykyk)

okay so real talk: this is the manual page for utoprc, aka the vibe-settings file for utop. sit down, grab a strawberry πŸ“, and let's get you literate.


✨ NAME ✨

utoprc β€” the configuration file of utop πŸŽ€

✨ SYNOPSIS ✨

~/.utoprc

✨ DESCRIPTION ✨

okay so this page is literally here to explain the format of the ~/.utoprc file. it's a text file, it holds the configuration of utop, that's the whole deal πŸ’…

  • Comments start with a !
  • Empty lines are just ignored, they're not the main character, they get skipped

Configuration lines are shaped like this, no cap:

<wildcard>: <value>

<wildcard> is allowed to contain the * asterisk character. and when it does? any key that matches the pattern gets the value after the colon. wildcard behavior, iconic 🌈

The boolean key autoload can be set to false to disable the autoloading of files in $OCAML_TOPLEVEL_PATH/autoload at startup. yes, false disables it, that's the whole bit πŸ¦‹

The key external-editor can be set to a command line. it's used to edit the input when you press C-x C-e. and it defaults to the contents of the EDITOR environment variable. so if it's acting weird, check EDITOR first, bestie πŸ‘‘

The key profile may have the value dark or light. this is the same as calling UTop.set_profile in ~/.config/utop/init.ml. two ways, one outcome, periodt ✨

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

key.foreground and key.background are colors, and the others are booleans. so like, colors for the first two, yes/no vibes for the rest πŸ’œ

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 you specify an X11 color or a color given by its RGB components. so no, you don't get pixel-perfect, you get nearest, and that's the deal πŸ™ˆ

If you are using gnome-terminal or konsole, you can enable 256 colors by setting the environment variable TERM to "xterm-256color". do it. it's giving upgrade 🧚

✨ FILES ✨

  • ~/.utoprc

✨ EXAMPLE ✨

here's a whole look, steal it, it's yours:

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

✨ AUTHOR ✨

JΓ©rΓ©mie Dimino <jeremie@dimino.org> β€” the original main character πŸ‘‘ we love them for this.

✨ SEE ALSO ✨


and that's the whole page, bestie, you ate it 🫢 this beauty is from August 2011, UTOPRC(5), no notes, slay πŸ’…βœ¨