Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 2.06 KB

configuration.rst

File metadata and controls

33 lines (24 loc) · 2.06 KB
Raw

Configuration

This guide details how to customize the Ergonomica environments---both cosmetically and functionally.

.ergo_profile

Ergonomica, if loaded with the --login flag, will evaluate ~/.ergo/.ergo_profile. As such, it is typically used as the Ergonomica configuration file. This file is a normal Ergonomica file, and within it you may define variables and commands and execute commands. The environment command allows one to set various parameters about your Ergonomica sessions. The following are all the customizable variables of the Ergonomica environments and their defaults:

  • directory: The current directory in which Ergonomica is in. Defaults to the directory in which Ergonomica is invoked.
  • user: The current user. Defaults to the user that invokes Ergonomica.
  • home: The user's home directory. Defaults to what os yields for a home directory (os.getenv(key="HOME")).
  • welcome: The message shown after clearing the screen. Defaults to Ergonomica ASCII art:
  • EDITOR: The user's preferred text editor.
  • LANG: The user's preferred language. Currently only EN (english) is implemented.
  • prompt: The user's command-line prompt (known as PS1 in bash). Defaults to [<directory>]\n.: `; variables that are substituted in (to show relevant information) are :code:`<directory> (the current directory) and <user> (the current user).
  • path: the PATH used for when looking for commands. Uses /usr/libexec/path_helper on Mac---otherwise it might need to be set (depending on what terminal emulator you use).

toolbar and rprompt

The toolbar and rprompt commands allow one to set the content of various display boxes in Ergonomica.