The Configuration File

The main configuration file that hlg uses is config.toml found in the $HLG_HOME

When we say “the configuration file”, this is the file that we are referring to.

This file provides some general user options, like the default browser to be used, the file manager, and the command interpreter.

The following are all the options you find in the configuration file:

default-category

The category that is to be used by hlg when none is provided on the command-line.

create-missing-category

Set to either "yes" or "no". this tells hlg to create any missing categories on the fly. For example, if you type hlg -c planes and there is no category called “planes”:

  • hlg will throw an error and quit if this setting is set to no. hlg cannot create the missing category for you. You have to do it manually before calling the name of the missing category.

  • You can have hlg create the "planes" category for you if the "create-missing-category" is set to "yes". The setback with this option is that you may end up creating many categories even for typos of already-existing categories. So the default setting is "no" You can change it to "yes" if you like.

home

The name of the main home bookmark. You can enter it as a fully-qualified bookmark name or just a name. The advantage of entering it as a fully-qualified name is that even if you change your default-category, this bookmark will still be correctly resolved. If you just enter a name without a category, hlg will assume that the bookmark name is found in the default category. When you reassign the default-category option, you have to remember to adjust its entry to avoid the errors with hlg

script-dir

The directory where script files linked in the command bookmark locations are found. By default, scripts are in the scripts subdirectory of the $HLG_HOME.

file-manager

A program to launch bookmarks that link to other locations on the filesystem.

browser

A program that links bookmarks to locations on the web.

command

A command interpreter to run your commands, whether they be inline or not.

To edit the Configuration file

To edit the configuration file, simply call hlg with the --edit-configuration or -E option.

It will open the configuration file where you can adjust all or some of these options to your taste.

Remember to save the file after making any changes, otherwise they will be discarded.