github.com/lmorg/murex@v0.0.0-20240217211045-e081c89cd4ef/gen/user-guide/profile_doc.yaml (about)

     1  - DocumentID: profile
     2    Title: >-
     3      Profile Files
     4    CategoryID: user-guide
     5    Summary: >-
     6      A breakdown of the different files loaded on start up
     7    Description: |-
     8      ## Description
     9      
    10      Murex has several profile files which are loaded in the following order of
    11      execution:
    12  
    13      1. `~/.murex_preload`
    14      2. `~/.murex_modules/*/`
    15      3. `~/.murex_profile`
    16  
    17      ### `.murex_preload`
    18  
    19      This file should only used to define any environmental variables that might
    20      need to be set before the modules are loaded (eg including directories in
    21      `$PATH` if you have anything installed in non-standard locations).
    22  
    23      Most of the time this file will be empty bar the standard warning message:
    24  
    25          # This file is loaded before any murex modules. It should only contain
    26          # environmental variables required for the modules to work eg:
    27          #
    28          #     export PATH=...
    29          #
    30          # Any other profile config belongs in your profile script instead:
    31          # /home/$USER/.murex_profile
    32  
    33      This file is created upon the first run of Murex.
    34  
    35      ### `.murex_modules/`
    36  
    37      Murex's module directory - where all the modules are installed
    38      to. This directory is managed by `murex-package` builtin.
    39  
    40      ### `.murex_profile`
    41  
    42      This file is comparable to `.bash_profile`, `.bashrc` and `.zshrc` etc. It
    43      is the standard place to put all user and/or machine specific config in.
    44  
    45      `.murex_profile` is only read from the users home directory. Unlike bash et
    46      al, profiles will not be read from `/etc/profile.d` nor similar. Modules
    47      should be used in its place.
    48  
    49      ## Overriding The Default Paths (XDG)
    50  
    51      Some individuals, particularly those running Linux, follow a standard called
    52      [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html).
    53      While Murex does not adhere to this standard, instead conforming to the
    54      _de facto_ standard defined by the past precedents of previous shells, in
    55      order to offer flexibility for those who do prefer the XDG specification
    56      Murex does support overriding its own default paths via special environmental
    57      variables.
    58  
    59      - `MUREX_PRELOAD` defines the preload path (and file name)
    60      - `MUREX_MODULES` defines the module path (only)
    61      - `MUREX_PROFILE` defines the profile path (and file name)
    62  
    63      Where `MUREX_PRELOAD` and/or `MUREX_PROFILE` are directories rather than
    64      absolute file names, the path is appended with the default file names as
    65      named above.
    66  
    67      For people who wish to use XDG paths, in many instances you can get away
    68      with setting the follow prior to launching Murex (eg in `/etc/profile.d`):
    69  
    70      ```
    71      MUREX_PRELOAD="$XDG_CONFIG_HOME/murex/"
    72      MUREX_MODULES="$XDG_CONFIG_HOME/murex/"
    73      MUREX_PROFILE="$XDG_CONFIG_HOME/murex/"
    74      ```
    75  
    76      This, however, depends on `$XDG_CONFIG_HOME` pointing to a single path rather
    77      than an array of paths (like `$PATH`). In that instance you can still use
    78      custom paths in Murex but you might need to get a little more creative in
    79      how you define that value.
    80    Synonyms:
    81    - profile
    82    - .murex_profile
    83    - murex_profile
    84    - .murex_preload
    85    - murex_preload
    86    Related:
    87    - murex-package
    88    - modules
    89    - export