From 0541aae4c21bda0d17e643643092ed9aace98797 Mon Sep 17 00:00:00 2001 From: Daniel Zwell Date: Wed, 17 Jun 2026 23:53:49 +0800 Subject: [PATCH 1/2] Link to the config paths page every time config files are listed. --- content/lua/a-simple-example.md | 2 +- content/lua/basic-principles.md | 4 +--- content/lua/installation.md | 2 +- content/lua/sharing-scripts.md | 5 +++-- content/module-reference/processing-modules/crop-rotate.md | 2 +- content/module-reference/processing-modules/crop.md | 2 +- .../processing-modules/input-color-profile.md | 2 +- .../processing-modules/output-color-profile.md | 2 +- content/module-reference/processing-modules/watermark.md | 2 +- .../module-reference/utility-modules/darkroom/soft-proof.md | 2 +- content/preferences-settings/general.md | 4 ++-- content/preferences-settings/lighttable.md | 2 +- .../special-topics/darktable-chart/making-input-images.md | 2 +- content/special-topics/mem-performance.md | 4 ++-- content/special-topics/program-invocation/darktable.md | 6 +++--- .../program-invocation/purge_non_existing_images_sh.md | 2 +- 16 files changed, 22 insertions(+), 23 deletions(-) diff --git a/content/lua/a-simple-example.md b/content/lua/a-simple-example.md index 28f3b68054..82124d85d0 100644 --- a/content/lua/a-simple-example.md +++ b/content/lua/a-simple-example.md @@ -4,7 +4,7 @@ id: a-simple-lua-example weight: 30 --- -Let's start with a simple example that will print some code on the console. Create a file called `luarc` in darktable's configuration directory (usually `$HOME/.config/darktable/`) and add the following line to it: +Let's start with a simple example that will print some code on the console. Create a file called `luarc` in darktable's [configuration directory](../preferences-settings/config-folder.md) and add the following line to it: ``` print("Hello World !") diff --git a/content/lua/basic-principles.md b/content/lua/basic-principles.md index 6ca2960f8d..5e47b9e85a 100644 --- a/content/lua/basic-principles.md +++ b/content/lua/basic-principles.md @@ -4,9 +4,7 @@ id: basic-principles weight: 20 --- -At startup, darktable will automatically run the Lua scripts `$DARKTABLE/share/darktable/luarc` and `$HOME/.config/darktable/luarc` (where `$DARKTABLE` represents the darktable installation directory and `$HOME` represents your home directory). - -The specific path of luarc depends on your OS and chosen method of installation. See [config-dirs](../preferences-settings/config-folder.md) for detailed information. +At startup, darktable will automatically run the Lua scripts `$DARKTABLE/share/darktable/luarc` (where `$DARKTABLE` represents the darktable installation directory) and `luarc` in the darktable [configuration directory](../preferences-settings/config-folder.md). This is the only time darktable will run Lua scripts by itself and can be used to load other scripts (like the script manager). These scripts can register callbacks to perform actions on various darktable events. This callback mechanism is the primary method of triggering lua actions. diff --git a/content/lua/installation.md b/content/lua/installation.md index 4a51aca31b..f48dc2306d 100644 --- a/content/lua/installation.md +++ b/content/lua/installation.md @@ -8,7 +8,7 @@ weight: 15 A collection of scripts is available in the [lua-scripts repository](https://github.com/darktable-org/lua-scripts). This also includes the script manager, which makes it easier to enable or disable individual scripts from the GUI. To use these existing scripts, they must be installed in darktable. This can in most cases be done within darktable's GUI, but depends on your OS and chosen method of installation. -In any case, darktable should be started at least once to set up its directories. +In any case, darktable should be started at least once to set up its directories. The config directories for most installation types are listed on the [configuration directory](../preferences-settings/config-folder.md) page. ### Linux Package, AppImage and Flatpak diff --git a/content/lua/sharing-scripts.md b/content/lua/sharing-scripts.md index ccf48fff1a..4ed7d7d52d 100644 --- a/content/lua/sharing-scripts.md +++ b/content/lua/sharing-scripts.md @@ -15,8 +15,7 @@ AUTHOR Jérémy Rosen (jeremy.rosen@enst-bretagne.fr) INSTALLATION -* copy this file in $CONFIGDIR/lua/ where CONFIGDIR -is your darktable configuration directory +* copy this file in $CONFIGDIR/lua/ * add the following line in the file $CONFIGDIR/luarc require "scp-storage" @@ -62,6 +61,8 @@ darktable.register_storage("scp_export","Export via scp", darktable will look for scripts (following the normal lua rules) in the standard directories plus `$CONFIGDIR/lua/*.lua`. So our script can be called by simply adding `require "scp-storage"` in the _luarc_ file. A couple of extra notes... +- `$CONFIGDIR` represents the darktable [configuration directory](../preferences-settings/config-folder.md). + - The function `dtutils.check_min_api_version` will check compatibility for you. `"7.0.0"` is the API version you have tested your script with and the "`...`" will turn into your script's name. - Make sure to declare all your functions as `local` so as not to pollute the general namespace. diff --git a/content/module-reference/processing-modules/crop-rotate.md b/content/module-reference/processing-modules/crop-rotate.md index b71d724a7a..fb91b9d391 100644 --- a/content/module-reference/processing-modules/crop-rotate.md +++ b/content/module-reference/processing-modules/crop-rotate.md @@ -64,7 +64,7 @@ aspect : You can also enter any other ratio after opening the combobox by typing it in the form of “x:y” or as a decimal (e.g. "0.5" to apply a ratio of 2:1). -: If you want to add an aspect ratio to the pre-defined drop-down list you can do this by including a line of the form "`plugins/darkroom/clipping/extra_aspect_ratios/foo=x:y`" in darktable's configuration file `$HOME/.config/darktable/darktablerc`. Here “`foo`” defines the name of the new aspect ratio and “`x`” and “`y`” the corresponding numerical values (`x` and `y` must be integers). Note that you can only add new entries for ratios not already present in the drop-down list. +: If you want to add an aspect ratio to the pre-defined drop-down list you can do this by including a line of the form "`plugins/darkroom/clipping/extra_aspect_ratios/foo=x:y`" in darktable's configuration file `darktablerc` in the [configuration directory](../../preferences-settings/config-folder.md). Here “`foo`” defines the name of the new aspect ratio and “`x`” and “`y`” the corresponding numerical values (`x` and `y` must be integers). Note that you can only add new entries for ratios not already present in the drop-down list. : Finally, the button beside the aspect combobox allows you to switch between portrait and landscape orientation if you have selected a rectangular aspect ratio. diff --git a/content/module-reference/processing-modules/crop.md b/content/module-reference/processing-modules/crop.md index f286cc3e92..c08395e8fb 100644 --- a/content/module-reference/processing-modules/crop.md +++ b/content/module-reference/processing-modules/crop.md @@ -33,7 +33,7 @@ aspect : The button beside the aspect combobox allows you to switch between portrait and landscape orientation if you have selected a rectangular aspect ratio. -: If you want to add an aspect ratio to the pre-defined drop-down list you can do this by including a line of the form "`plugins/darkroom/clipping/extra_aspect_ratios/foo=x:y`" in darktable's configuration file `$HOME/.config/darktable/darktablerc`. Here "`foo`" defines the name of the new aspect ratio and “`x`” and “`y`” the corresponding numerical values (`x` and `y` must be integers). Note that you can only add new entries for ratios not already present in the drop-down list. You can not use fractions as the actual crop size, however you can for the name. For example, if you want an aspect ratio of 1.91:1, add the following to your darktablerc file: `plugins/darkroom/clipping/extra_aspect_ratios/1.91:1=191:100` +: If you want to add an aspect ratio to the pre-defined drop-down list you can do this by including a line of the form "`plugins/darkroom/clipping/extra_aspect_ratios/foo=x:y`" in darktable's configuration file `darktablerc` in the [configuration directory](../../preferences-settings/config-folder.md). Here "`foo`" defines the name of the new aspect ratio and “`x`” and “`y`” the corresponding numerical values (`x` and `y` must be integers). Note that you can only add new entries for ratios not already present in the drop-down list. You can not use fractions as the actual crop size, however you can for the name. For example, if you want an aspect ratio of 1.91:1, add the following to your darktablerc file: `plugins/darkroom/clipping/extra_aspect_ratios/1.91:1=191:100` --- diff --git a/content/module-reference/processing-modules/input-color-profile.md b/content/module-reference/processing-modules/input-color-profile.md index ad5d54d72e..d0bef10aea 100644 --- a/content/module-reference/processing-modules/input-color-profile.md +++ b/content/module-reference/processing-modules/input-color-profile.md @@ -19,7 +19,7 @@ Note that the final color profile that will be used when exporting the image is input profile : The profile or color matrix to apply. A number of matrices are provided along with an enhanced color matrix for some camera models. The enhanced matrices are designed to provide a look that is closer to that of the camera manufacturer. -: You can also supply your own input ICC profiles and put them into `$DARKTABLE/share/darktable/color/in` or `$HOME/.config/darktable/color/in` (where `$DARKTABLE` is the darktable installation directory and `$HOME` is your home directory). Note that these `color/in` directories are not created by the darktable install; if you need to use one, you must create it yourself. One common source of ICC profiles is the software that is shipped with your camera, which often contains profiles specific to your camera model. You may need to activate the [_unbreak input profile_](./unbreak-input-profile.md) module to use your own profiles. +: You can also supply your own input ICC profiles and put them into `$DARKTABLE/share/darktable/color/in` (where `$DARKTABLE` is the darktable installation directory) or `color/in` in the darktable [configuration directory](../../preferences-settings/config-folder.md). Note that these `color/in` directories are not created by the darktable install; if you need to use one, you must create it yourself. One common source of ICC profiles is the software that is shipped with your camera, which often contains profiles specific to your camera model. You may need to activate the [_unbreak input profile_](./unbreak-input-profile.md) module to use your own profiles. : If your input image is a low dynamic range file like JPEG, or a raw file in DNG format, it might already contain an embedded ICC profile, which darktable will use by default. You can restore this default by selecting “embedded icc profile”. If you hover your mouse over the input profile combobox on such an image, details of the embedded profile will be shown in a tooltip. diff --git a/content/module-reference/processing-modules/output-color-profile.md b/content/module-reference/processing-modules/output-color-profile.md index 1a09c6bce2..1b9c0ab46a 100644 --- a/content/module-reference/processing-modules/output-color-profile.md +++ b/content/module-reference/processing-modules/output-color-profile.md @@ -6,7 +6,7 @@ weight: 10 Manage the output profile for export and the rendering intent to be used when mapping between color spaces. -darktable comes with pre-defined profiles _sRGB_, _Adobe RGB_, _XYZ_ and _linear RGB_. You can provide additional profiles by placing them in `$DARKTABLE/share/darktable/color/out` and `$HOME/.config/darktable/color/out` (where `$DARKTABLE` is the darktable installation directory and `$HOME` is your home directory). Note that these `color/out` directories are not created by the darktable install; if you need to use one, you must create it yourself. +darktable comes with pre-defined profiles _sRGB_, _Adobe RGB_, _XYZ_ and _linear RGB_. You can provide additional profiles by placing them in `$DARKTABLE/share/darktable/color/out` (where `$DARKTABLE` is the darktable installation directory) or `color/out` in the darktable [configuration directory](../../preferences-settings/config-folder.md). Note that these `color/out` directories are not created by the darktable install; if you need to use one, you must create it yourself. The output color profile may also be defined within the [export](../utility-modules/shared/export.md) module. diff --git a/content/module-reference/processing-modules/watermark.md b/content/module-reference/processing-modules/watermark.md index d6d56a6983..b573c05b03 100644 --- a/content/module-reference/processing-modules/watermark.md +++ b/content/module-reference/processing-modules/watermark.md @@ -10,7 +10,7 @@ You can also use bitmap (PNG) images. The SVG processor in darktable can also substitute strings within an SVG document, allowing image-dependent information to be included in the watermark. -User-designed watermarks should be placed into the directory `$HOME/.config/darktable/watermarks`. Once in place, use the reload button update the list of available watermarks. +User-designed watermarks should be placed into the `watermarks` folder in the darktable [configuration directory](../../preferences-settings/config-folder.md). Once in place, use the reload button update the list of available watermarks. The following is a list of variable strings that are supported for substitution within an SVG document. diff --git a/content/module-reference/utility-modules/darkroom/soft-proof.md b/content/module-reference/utility-modules/darkroom/soft-proof.md index d401885a24..b9595d4c45 100644 --- a/content/module-reference/utility-modules/darkroom/soft-proof.md +++ b/content/module-reference/utility-modules/darkroom/soft-proof.md @@ -7,7 +7,7 @@ View your image rendered using a selected color profile. Click the ![soft proof](./soft-proof/soft-proof-icon.png#icon) icon to activate the soft proof display mode on your image. This allows you to preview your image rendered using a printer profile to see how colors will end up on the final print. You can also activate soft proof with the keyboard shortcut Ctrl+S. A message “soft proof" on the bottom left of your image tells you that you are in soft proof display mode. -Right-click on the icon to open a dialog with the following configuration parameters. For each of these parameters, the list of available profiles is read from `$DARKTABLE/share/darktable/color/out` and `$HOME/.config/darktable/color/out` (where `$DARKTABLE` represents darktable's installation directory and `$HOME` your home directory). Note that these `color/out` directories are not created by the darktable install; if you need to use one, you must create it yourself. +Right-click on the icon to open a dialog with the following configuration parameters. For each of these parameters, the list of available profiles is read from `$DARKTABLE/share/darktable/color/out` (where `$DARKTABLE` represents darktable's installation directory) and `color/out` in the darktable [configuration directory](../../../preferences-settings/config-folder.md). Note that these `color/out` directories are not created by the darktable install; if you need to use one, you must create it yourself. display profile : Set the color profile for the display. The option “system display profile” is the preferred setting when working with a calibrated display. The profile is taken either from your system's color manager or from your X display server. The method darktable uses to detect your system display profile can be changed in [preferences > miscellaneous](../../../preferences-settings/miscellaneous.md). For more information see the [display profile](../../../special-topics/color-management/display-profile.md) section. diff --git a/content/preferences-settings/general.md b/content/preferences-settings/general.md index 6a1e8a9cce..f48fd259ea 100644 --- a/content/preferences-settings/general.md +++ b/content/preferences-settings/general.md @@ -31,14 +31,14 @@ In addition to selecting a pre-built theme you can also apply additional CSS cus Two different methods are provided for this: create a custom theme -: If you wish to make a large number of changes to darktable's UI you may wish to create your own theme (in a `.css` file) and place it in `$HOME/.config/darktable/themes` (or `C:\%LOCALAPPDATA%\darktable\themes` on Windows). Your new theme will automatically appear in the _theme_ selection list the next time you restart darktable. +: If you wish to make a large number of changes to darktable's UI you may wish to create your own theme (in a `.css` file) and place it in the `themes` folder in the darktable [configuration directory](../preferences-settings/config-folder.md).. Your new theme will automatically appear in the _theme_ selection list the next time you restart darktable. : Please note that the structure of darktable's internal CSS changes frequently and you may need to make significant changes to your own themes when new versions of darktable are released. For this reason (among others) we do not recommend creating complex custom themes unless you are willing to devote a lot of time to ongoing maintenance. If your theme loads any of darktable's pre-built themes using the `@import url` directive, note that your CSS theme file may not be portable between installations (`@import url` uses relative paths and the location of the pre-built themes is system-dependent). create theme tweaks : A text box is provided at the bottom of the general tab within which you can enter your own CSS tweaks. When using this option, darktable will first load your selected theme (the "base" theme, chosen in the _theme_ drop-down) and then apply your custom CSS on top. This means that you can easily make minor alterations to the look-and-feel, while still keeping mostly up-to-date with core theme changes when a new version of darktable is released. It also means that you can usually change your base theme without affecting your custom CSS tweaks. -: When you have finished entering your CSS, click the "save CSS and apply" button. This will save your CSS to `$HOME/.config/darktable/user.css` (or `C:\%LOCALAPPDATA%\darktable\user.css` on Windows) and immediately apply it to the current darktable session. +: When you have finished entering your CSS, click the "save CSS and apply" button. This will save your CSS to `user.css` in the darktable [configuration directory](../preferences-settings/config-folder.md). and immediately apply it to the current darktable session. : If you notice any issues after applying your CSS, you can uncheck the "modify selected theme with CSS tweaks below" box to revert. This will immediately restore the base theme but will leave your tweaks in the editor so that you can re-edit them and try again. Simply press "save CSS and apply" again when you are ready to retry. This will automatically re-check the "modify selected theme with CSS tweaks below" checkbox and apply the new CSS. diff --git a/content/preferences-settings/lighttable.md b/content/preferences-settings/lighttable.md index 253e6ae4dd..2a8b275a10 100644 --- a/content/preferences-settings/lighttable.md +++ b/content/preferences-settings/lighttable.md @@ -52,7 +52,7 @@ enable smooth scrolling for lighttable thumbnails generate thumbnails in background : Choose whether to automatically generate thumbnails in the background when the user is in the lighttable view and is inactive (no keyboard/mouse activity). Thumbnails will be generated up to the selected size (default never). -: _**Note:** You can set the period of inactivity required before thumbnail generation will start by altering the `backthumbs_inactivity` setting in `$HOME/.config/darktable/darktablerc` (default 5 seconds)._ +: _**Note:** You can set the period of inactivity required before thumbnail generation will start by altering the `backthumbs_inactivity` setting in `darktablerc` in the darktable [configuration directory](../preferences-settings/config-folder.md) (default 5 seconds)._ reset cached thumbnails : Force thumbnails to be regenerated by resetting the database. This may be needed if some thumbnails have been manually removed or have become corrupted (default off). diff --git a/content/special-topics/darktable-chart/making-input-images.md b/content/special-topics/darktable-chart/making-input-images.md index 3b00b57dc8..dd7e6b32d5 100644 --- a/content/special-topics/darktable-chart/making-input-images.md +++ b/content/special-topics/darktable-chart/making-input-images.md @@ -12,7 +12,7 @@ There is a special situation if your camera automatically applies some lens corr To output your image go to the [export](../../module-reference/utility-modules/shared/export.md) module in the lighttable. -You will need to select “Lab” as the output color profile. This color space is not visible in the combobox by default. You first need to enable it by setting `allow_lab_output` to `TRUE` in `$HOME/.config/darktable/darktablerc`. Alternatively, you can start darktable with: +You will need to select “Lab” as the output color profile. This color space is not visible in the combobox by default. You first need to enable it by setting `allow_lab_output` to `TRUE` in darktable's configuration file `darktablerc` in the [configuration directory](../../preferences-settings/config-folder.md). Alternatively, you can start darktable with: ``` darktable --conf allow_lab_output=true diff --git a/content/special-topics/mem-performance.md b/content/special-topics/mem-performance.md index 84d3bdb896..e2c2ec59fb 100644 --- a/content/special-topics/mem-performance.md +++ b/content/special-topics/mem-performance.md @@ -23,7 +23,7 @@ For most systems, tiling will probably only be used for full-sized image exports # performance tuning -There are a number of configuration parameters that can help you to fine-tune your system's performance. Some of these parameters are available in [preferences > processing > CPU / memory](../preferences-settings/processing.md#cpu--memory) and others need to be modified directly in darktable's configuration file (found in `$HOME/.config/darktable/darktablerc`). +There are a number of configuration parameters that can help you to fine-tune your system's performance. Some of these parameters are available in [preferences > processing > CPU / memory](../preferences-settings/processing.md#cpu--memory) and others need to be modified directly in darktable's configuration file (`darktablerc` in the darktable [configuration directory](../preferences-settings/config-folder.md)). This section provides some guidance on how to adjust these settings. @@ -49,7 +49,7 @@ On the other hand darktable's performance during file exports is more or less on ## darktable resources -The "darktable resources" preference (in [preferences > processing > CPU / memory](../preferences-settings/processing.md#cpu--memory)) allows you to choose between four different approaches to allocating your system's resources to darktable. Each of these options controls multiple individual parameters, which are defined independently in `$HOME/.config/darktable/darktablerc`. You can amend any of these directly within your darktablerc file to tweak values for your selected resource level, though you cannot add your own custom resource level to the preferences drop-down. +The "darktable resources" preference (in [preferences > processing > CPU / memory](../preferences-settings/processing.md#cpu--memory)) allows you to choose between four different approaches to allocating your system's resources to darktable. Each of these options controls multiple individual parameters, which are defined independently in `darktablerc` in the darktable [configuration directory](../preferences-settings/config-folder.md). You can amend any of these directly within your darktablerc file to tweak values for your selected resource level, though you cannot add your own custom resource level to the preferences drop-down. Each of the four "darktable resources" options are defined as follows: diff --git a/content/special-topics/program-invocation/darktable.md b/content/special-topics/program-invocation/darktable.md index 084591cbdd..6fffcd9a1e 100644 --- a/content/special-topics/program-invocation/darktable.md +++ b/content/special-topics/program-invocation/darktable.md @@ -56,10 +56,10 @@ All parameters are optional. In most cases darktable should be started without a : Prevent darktable from initializing the OpenCL subsystem. Use this option if darktable crashes at startup due to a defective OpenCL implementation. `--configdir ` -: Define the directory where darktable stores user-specific configuration. The default location is `$HOME/.config/darktable/`. +: Define the directory where darktable stores user-specific configuration. The default paths are listed in: [configuration directory](../../preferences-settings/config-folder.md) `--library ` -: darktable keeps image information in an sqlite database for fast access. The default location of that database file is file name `library.db` in the directory specified by `--configdir` or defaulted to `$HOME/.config/darktable/`. Use this option to provide an alternative location (e.g. if you want to do some experiments without compromising your original `library.db`). If the database file does not exist, darktable creates it for you. You may also provide `:memory:` as the library file, in which case the database is kept in system memory -- all changes are discarded when darktable terminates. +: darktable keeps image information in an sqlite database for fast access. The default location of that database file is file name `library.db` in the directory specified by `--configdir` or the default [configuration directory](../../preferences-settings/config-folder.md). Use this option to provide an alternative location (e.g. if you want to do some experiments without compromising your original `library.db`). If the database file does not exist, darktable creates it for you. You may also provide `:memory:` as the library file, in which case the database is kept in system memory -- all changes are discarded when darktable terminates. : Whenever darktable starts, it will lock the library to the current user. It does this by writing the current process identifier (PID) into a lock file `.lock` next to the library specified. If darktable finds an existing lock file for the library, it will terminate immediately. @@ -86,7 +86,7 @@ All parameters are optional. In most cases darktable should be started without a : Provide a json file that contains camera-specific noise profiles. The default location depends on your installation. Typical locations are `/opt/darktable/share/darktable/noiseprofile.json` and `/usr/share/darktable/noiseprofile.json`. `--conf =` -: darktable supports a rich set of configuration parameters defined by the user in file `darktablerc`, located in the directory specified by `--configdir` or defaulted to `$HOME/.config/darktable/`. You may temporarily overwrite individual settings on the command line with this option -- these settings will not be stored in `darktablerc` on exit. +: darktable supports a rich set of configuration parameters defined by the user in file `darktablerc`, located in the directory specified by `--configdir` or the default [configuration directory](../../preferences-settings/config-folder.md). You may temporarily overwrite individual settings on the command line with this option -- these settings will not be stored in `darktablerc` on exit. `-t ` : limit number of openmp threads to use in openmp parallel sections. diff --git a/content/special-topics/program-invocation/purge_non_existing_images_sh.md b/content/special-topics/program-invocation/purge_non_existing_images_sh.md index d3ca4c77cb..c7e9e8b324 100644 --- a/content/special-topics/program-invocation/purge_non_existing_images_sh.md +++ b/content/special-topics/program-invocation/purge_non_existing_images_sh.md @@ -19,7 +19,7 @@ Run the script with no options to perform a "dry run", which generates a report The available options are: `-c|--configdir ` -: Specify the path to the darktable configuration directory to be used by the script. If this option is not provided, the default config directory location will be used. +: Specify the path to the darktable configuration directory to be used by the script. If this option is not provided, the default [configuration directory](../../preferences-settings/config-folder.md) location will be used. `-l|--library ` : Specify the path to the library.db database file to be analysed by the script. If this option is not specified, the default library.db file location will be used. From 6463ff59ad697400b5b2f09a354ca2ad8443ad73 Mon Sep 17 00:00:00 2001 From: Daniel Zwell Date: Thu, 18 Jun 2026 14:05:04 +0800 Subject: [PATCH 2/2] Rename config-folder.md to config-directory.md Also, fix multiple full stops at end of sentence. --- content/lua/a-simple-example.md | 2 +- content/lua/basic-principles.md | 2 +- content/lua/installation.md | 2 +- content/lua/sharing-scripts.md | 2 +- content/module-reference/processing-modules/crop-rotate.md | 2 +- content/module-reference/processing-modules/crop.md | 2 +- .../processing-modules/input-color-profile.md | 2 +- .../processing-modules/output-color-profile.md | 2 +- content/module-reference/processing-modules/watermark.md | 2 +- .../module-reference/utility-modules/darkroom/soft-proof.md | 2 +- .../{config-folder.md => config-directory.md} | 6 +++--- content/preferences-settings/general.md | 4 ++-- content/preferences-settings/lighttable.md | 2 +- .../special-topics/darktable-chart/making-input-images.md | 2 +- content/special-topics/mem-performance.md | 4 ++-- content/special-topics/program-invocation/darktable.md | 6 +++--- .../program-invocation/purge_non_existing_images_sh.md | 2 +- 17 files changed, 23 insertions(+), 23 deletions(-) rename content/preferences-settings/{config-folder.md => config-directory.md} (74%) diff --git a/content/lua/a-simple-example.md b/content/lua/a-simple-example.md index 82124d85d0..0d2ca4694b 100644 --- a/content/lua/a-simple-example.md +++ b/content/lua/a-simple-example.md @@ -4,7 +4,7 @@ id: a-simple-lua-example weight: 30 --- -Let's start with a simple example that will print some code on the console. Create a file called `luarc` in darktable's [configuration directory](../preferences-settings/config-folder.md) and add the following line to it: +Let's start with a simple example that will print some code on the console. Create a file called `luarc` in darktable's [configuration directory](../preferences-settings/config-directory.md) and add the following line to it: ``` print("Hello World !") diff --git a/content/lua/basic-principles.md b/content/lua/basic-principles.md index 5e47b9e85a..b34b6283ab 100644 --- a/content/lua/basic-principles.md +++ b/content/lua/basic-principles.md @@ -4,7 +4,7 @@ id: basic-principles weight: 20 --- -At startup, darktable will automatically run the Lua scripts `$DARKTABLE/share/darktable/luarc` (where `$DARKTABLE` represents the darktable installation directory) and `luarc` in the darktable [configuration directory](../preferences-settings/config-folder.md). +At startup, darktable will automatically run the Lua scripts `$DARKTABLE/share/darktable/luarc` (where `$DARKTABLE` represents the darktable installation directory) and `luarc` in the darktable [configuration directory](../preferences-settings/config-directory.md). This is the only time darktable will run Lua scripts by itself and can be used to load other scripts (like the script manager). These scripts can register callbacks to perform actions on various darktable events. This callback mechanism is the primary method of triggering lua actions. diff --git a/content/lua/installation.md b/content/lua/installation.md index f48dc2306d..846fc18f07 100644 --- a/content/lua/installation.md +++ b/content/lua/installation.md @@ -8,7 +8,7 @@ weight: 15 A collection of scripts is available in the [lua-scripts repository](https://github.com/darktable-org/lua-scripts). This also includes the script manager, which makes it easier to enable or disable individual scripts from the GUI. To use these existing scripts, they must be installed in darktable. This can in most cases be done within darktable's GUI, but depends on your OS and chosen method of installation. -In any case, darktable should be started at least once to set up its directories. The config directories for most installation types are listed on the [configuration directory](../preferences-settings/config-folder.md) page. +In any case, darktable should be started at least once to set up its directories. The config directories for most installation types are listed on the [configuration directory](../preferences-settings/config-directory.md) page. ### Linux Package, AppImage and Flatpak diff --git a/content/lua/sharing-scripts.md b/content/lua/sharing-scripts.md index 4ed7d7d52d..03ce4a4809 100644 --- a/content/lua/sharing-scripts.md +++ b/content/lua/sharing-scripts.md @@ -61,7 +61,7 @@ darktable.register_storage("scp_export","Export via scp", darktable will look for scripts (following the normal lua rules) in the standard directories plus `$CONFIGDIR/lua/*.lua`. So our script can be called by simply adding `require "scp-storage"` in the _luarc_ file. A couple of extra notes... -- `$CONFIGDIR` represents the darktable [configuration directory](../preferences-settings/config-folder.md). +- `$CONFIGDIR` represents the darktable [configuration directory](../preferences-settings/config-directory.md). - The function `dtutils.check_min_api_version` will check compatibility for you. `"7.0.0"` is the API version you have tested your script with and the "`...`" will turn into your script's name. diff --git a/content/module-reference/processing-modules/crop-rotate.md b/content/module-reference/processing-modules/crop-rotate.md index fb91b9d391..487de79548 100644 --- a/content/module-reference/processing-modules/crop-rotate.md +++ b/content/module-reference/processing-modules/crop-rotate.md @@ -64,7 +64,7 @@ aspect : You can also enter any other ratio after opening the combobox by typing it in the form of “x:y” or as a decimal (e.g. "0.5" to apply a ratio of 2:1). -: If you want to add an aspect ratio to the pre-defined drop-down list you can do this by including a line of the form "`plugins/darkroom/clipping/extra_aspect_ratios/foo=x:y`" in darktable's configuration file `darktablerc` in the [configuration directory](../../preferences-settings/config-folder.md). Here “`foo`” defines the name of the new aspect ratio and “`x`” and “`y`” the corresponding numerical values (`x` and `y` must be integers). Note that you can only add new entries for ratios not already present in the drop-down list. +: If you want to add an aspect ratio to the pre-defined drop-down list you can do this by including a line of the form "`plugins/darkroom/clipping/extra_aspect_ratios/foo=x:y`" in darktable's configuration file `darktablerc` in the [configuration directory](../../preferences-settings/config-directory.md). Here “`foo`” defines the name of the new aspect ratio and “`x`” and “`y`” the corresponding numerical values (`x` and `y` must be integers). Note that you can only add new entries for ratios not already present in the drop-down list. : Finally, the button beside the aspect combobox allows you to switch between portrait and landscape orientation if you have selected a rectangular aspect ratio. diff --git a/content/module-reference/processing-modules/crop.md b/content/module-reference/processing-modules/crop.md index c08395e8fb..a925c580db 100644 --- a/content/module-reference/processing-modules/crop.md +++ b/content/module-reference/processing-modules/crop.md @@ -33,7 +33,7 @@ aspect : The button beside the aspect combobox allows you to switch between portrait and landscape orientation if you have selected a rectangular aspect ratio. -: If you want to add an aspect ratio to the pre-defined drop-down list you can do this by including a line of the form "`plugins/darkroom/clipping/extra_aspect_ratios/foo=x:y`" in darktable's configuration file `darktablerc` in the [configuration directory](../../preferences-settings/config-folder.md). Here "`foo`" defines the name of the new aspect ratio and “`x`” and “`y`” the corresponding numerical values (`x` and `y` must be integers). Note that you can only add new entries for ratios not already present in the drop-down list. You can not use fractions as the actual crop size, however you can for the name. For example, if you want an aspect ratio of 1.91:1, add the following to your darktablerc file: `plugins/darkroom/clipping/extra_aspect_ratios/1.91:1=191:100` +: If you want to add an aspect ratio to the pre-defined drop-down list you can do this by including a line of the form "`plugins/darkroom/clipping/extra_aspect_ratios/foo=x:y`" in darktable's configuration file `darktablerc` in the [configuration directory](../../preferences-settings/config-directory.md). Here "`foo`" defines the name of the new aspect ratio and “`x`” and “`y`” the corresponding numerical values (`x` and `y` must be integers). Note that you can only add new entries for ratios not already present in the drop-down list. You can not use fractions as the actual crop size, however you can for the name. For example, if you want an aspect ratio of 1.91:1, add the following to your darktablerc file: `plugins/darkroom/clipping/extra_aspect_ratios/1.91:1=191:100` --- diff --git a/content/module-reference/processing-modules/input-color-profile.md b/content/module-reference/processing-modules/input-color-profile.md index d0bef10aea..312d4433f2 100644 --- a/content/module-reference/processing-modules/input-color-profile.md +++ b/content/module-reference/processing-modules/input-color-profile.md @@ -19,7 +19,7 @@ Note that the final color profile that will be used when exporting the image is input profile : The profile or color matrix to apply. A number of matrices are provided along with an enhanced color matrix for some camera models. The enhanced matrices are designed to provide a look that is closer to that of the camera manufacturer. -: You can also supply your own input ICC profiles and put them into `$DARKTABLE/share/darktable/color/in` (where `$DARKTABLE` is the darktable installation directory) or `color/in` in the darktable [configuration directory](../../preferences-settings/config-folder.md). Note that these `color/in` directories are not created by the darktable install; if you need to use one, you must create it yourself. One common source of ICC profiles is the software that is shipped with your camera, which often contains profiles specific to your camera model. You may need to activate the [_unbreak input profile_](./unbreak-input-profile.md) module to use your own profiles. +: You can also supply your own input ICC profiles and put them into `$DARKTABLE/share/darktable/color/in` (where `$DARKTABLE` is the darktable installation directory) or `color/in` in the darktable [configuration directory](../../preferences-settings/config-directory.md). Note that these `color/in` directories are not created by the darktable install; if you need to use one, you must create it yourself. One common source of ICC profiles is the software that is shipped with your camera, which often contains profiles specific to your camera model. You may need to activate the [_unbreak input profile_](./unbreak-input-profile.md) module to use your own profiles. : If your input image is a low dynamic range file like JPEG, or a raw file in DNG format, it might already contain an embedded ICC profile, which darktable will use by default. You can restore this default by selecting “embedded icc profile”. If you hover your mouse over the input profile combobox on such an image, details of the embedded profile will be shown in a tooltip. diff --git a/content/module-reference/processing-modules/output-color-profile.md b/content/module-reference/processing-modules/output-color-profile.md index 1b9c0ab46a..79af3ef95f 100644 --- a/content/module-reference/processing-modules/output-color-profile.md +++ b/content/module-reference/processing-modules/output-color-profile.md @@ -6,7 +6,7 @@ weight: 10 Manage the output profile for export and the rendering intent to be used when mapping between color spaces. -darktable comes with pre-defined profiles _sRGB_, _Adobe RGB_, _XYZ_ and _linear RGB_. You can provide additional profiles by placing them in `$DARKTABLE/share/darktable/color/out` (where `$DARKTABLE` is the darktable installation directory) or `color/out` in the darktable [configuration directory](../../preferences-settings/config-folder.md). Note that these `color/out` directories are not created by the darktable install; if you need to use one, you must create it yourself. +darktable comes with pre-defined profiles _sRGB_, _Adobe RGB_, _XYZ_ and _linear RGB_. You can provide additional profiles by placing them in `$DARKTABLE/share/darktable/color/out` (where `$DARKTABLE` is the darktable installation directory) or `color/out` in the darktable [configuration directory](../../preferences-settings/config-directory.md). Note that these `color/out` directories are not created by the darktable install; if you need to use one, you must create it yourself. The output color profile may also be defined within the [export](../utility-modules/shared/export.md) module. diff --git a/content/module-reference/processing-modules/watermark.md b/content/module-reference/processing-modules/watermark.md index b573c05b03..d2bbcee921 100644 --- a/content/module-reference/processing-modules/watermark.md +++ b/content/module-reference/processing-modules/watermark.md @@ -10,7 +10,7 @@ You can also use bitmap (PNG) images. The SVG processor in darktable can also substitute strings within an SVG document, allowing image-dependent information to be included in the watermark. -User-designed watermarks should be placed into the `watermarks` folder in the darktable [configuration directory](../../preferences-settings/config-folder.md). Once in place, use the reload button update the list of available watermarks. +User-designed watermarks should be placed into the `watermarks` folder in the darktable [configuration directory](../../preferences-settings/config-directory.md). Once in place, use the reload button update the list of available watermarks. The following is a list of variable strings that are supported for substitution within an SVG document. diff --git a/content/module-reference/utility-modules/darkroom/soft-proof.md b/content/module-reference/utility-modules/darkroom/soft-proof.md index b9595d4c45..7a0e777fcc 100644 --- a/content/module-reference/utility-modules/darkroom/soft-proof.md +++ b/content/module-reference/utility-modules/darkroom/soft-proof.md @@ -7,7 +7,7 @@ View your image rendered using a selected color profile. Click the ![soft proof](./soft-proof/soft-proof-icon.png#icon) icon to activate the soft proof display mode on your image. This allows you to preview your image rendered using a printer profile to see how colors will end up on the final print. You can also activate soft proof with the keyboard shortcut Ctrl+S. A message “soft proof" on the bottom left of your image tells you that you are in soft proof display mode. -Right-click on the icon to open a dialog with the following configuration parameters. For each of these parameters, the list of available profiles is read from `$DARKTABLE/share/darktable/color/out` (where `$DARKTABLE` represents darktable's installation directory) and `color/out` in the darktable [configuration directory](../../../preferences-settings/config-folder.md). Note that these `color/out` directories are not created by the darktable install; if you need to use one, you must create it yourself. +Right-click on the icon to open a dialog with the following configuration parameters. For each of these parameters, the list of available profiles is read from `$DARKTABLE/share/darktable/color/out` (where `$DARKTABLE` represents darktable's installation directory) and `color/out` in the darktable [configuration directory](../../../preferences-settings/config-directory.md). Note that these `color/out` directories are not created by the darktable install; if you need to use one, you must create it yourself. display profile : Set the color profile for the display. The option “system display profile” is the preferred setting when working with a calibrated display. The profile is taken either from your system's color manager or from your X display server. The method darktable uses to detect your system display profile can be changed in [preferences > miscellaneous](../../../preferences-settings/miscellaneous.md). For more information see the [display profile](../../../special-topics/color-management/display-profile.md) section. diff --git a/content/preferences-settings/config-folder.md b/content/preferences-settings/config-directory.md similarity index 74% rename from content/preferences-settings/config-folder.md rename to content/preferences-settings/config-directory.md index f6982a8936..4da5dad112 100644 --- a/content/preferences-settings/config-folder.md +++ b/content/preferences-settings/config-directory.md @@ -1,10 +1,10 @@ --- -title: configuration folder -id: config-folder +title: configuration directory +id: config-directory weight: 150 --- -darktable stores its settings, presets, styles, library database, etc. in a default folder. This folder's location depends on your operating system and installation method. It can be changed by using the `--config-dir` option (see [darktable invocation](../special-topics/program-invocation/darktable.md)). +darktable stores its settings, presets, styles, library database, etc. in a default directory. This directory's location depends on your operating system and installation method. It can be changed by using the `--config-dir` option (see [darktable invocation](../special-topics/program-invocation/darktable.md)). * Linux + Installed via package manager or AppImage: `$HOME/.config/darktable` diff --git a/content/preferences-settings/general.md b/content/preferences-settings/general.md index f48fd259ea..843eeb2738 100644 --- a/content/preferences-settings/general.md +++ b/content/preferences-settings/general.md @@ -31,14 +31,14 @@ In addition to selecting a pre-built theme you can also apply additional CSS cus Two different methods are provided for this: create a custom theme -: If you wish to make a large number of changes to darktable's UI you may wish to create your own theme (in a `.css` file) and place it in the `themes` folder in the darktable [configuration directory](../preferences-settings/config-folder.md).. Your new theme will automatically appear in the _theme_ selection list the next time you restart darktable. +: If you wish to make a large number of changes to darktable's UI you may wish to create your own theme (in a `.css` file) and place it in the `themes` folder in the darktable [configuration directory](../preferences-settings/config-directory.md). Your new theme will automatically appear in the _theme_ selection list the next time you restart darktable. : Please note that the structure of darktable's internal CSS changes frequently and you may need to make significant changes to your own themes when new versions of darktable are released. For this reason (among others) we do not recommend creating complex custom themes unless you are willing to devote a lot of time to ongoing maintenance. If your theme loads any of darktable's pre-built themes using the `@import url` directive, note that your CSS theme file may not be portable between installations (`@import url` uses relative paths and the location of the pre-built themes is system-dependent). create theme tweaks : A text box is provided at the bottom of the general tab within which you can enter your own CSS tweaks. When using this option, darktable will first load your selected theme (the "base" theme, chosen in the _theme_ drop-down) and then apply your custom CSS on top. This means that you can easily make minor alterations to the look-and-feel, while still keeping mostly up-to-date with core theme changes when a new version of darktable is released. It also means that you can usually change your base theme without affecting your custom CSS tweaks. -: When you have finished entering your CSS, click the "save CSS and apply" button. This will save your CSS to `user.css` in the darktable [configuration directory](../preferences-settings/config-folder.md). and immediately apply it to the current darktable session. +: When you have finished entering your CSS, click the "save CSS and apply" button. This will save your CSS to `user.css` in the darktable [configuration directory](../preferences-settings/config-directory.md). and immediately apply it to the current darktable session. : If you notice any issues after applying your CSS, you can uncheck the "modify selected theme with CSS tweaks below" box to revert. This will immediately restore the base theme but will leave your tweaks in the editor so that you can re-edit them and try again. Simply press "save CSS and apply" again when you are ready to retry. This will automatically re-check the "modify selected theme with CSS tweaks below" checkbox and apply the new CSS. diff --git a/content/preferences-settings/lighttable.md b/content/preferences-settings/lighttable.md index 2a8b275a10..3c51c52235 100644 --- a/content/preferences-settings/lighttable.md +++ b/content/preferences-settings/lighttable.md @@ -52,7 +52,7 @@ enable smooth scrolling for lighttable thumbnails generate thumbnails in background : Choose whether to automatically generate thumbnails in the background when the user is in the lighttable view and is inactive (no keyboard/mouse activity). Thumbnails will be generated up to the selected size (default never). -: _**Note:** You can set the period of inactivity required before thumbnail generation will start by altering the `backthumbs_inactivity` setting in `darktablerc` in the darktable [configuration directory](../preferences-settings/config-folder.md) (default 5 seconds)._ +: _**Note:** You can set the period of inactivity required before thumbnail generation will start by altering the `backthumbs_inactivity` setting in `darktablerc` in the darktable [configuration directory](../preferences-settings/config-directory.md) (default 5 seconds)._ reset cached thumbnails : Force thumbnails to be regenerated by resetting the database. This may be needed if some thumbnails have been manually removed or have become corrupted (default off). diff --git a/content/special-topics/darktable-chart/making-input-images.md b/content/special-topics/darktable-chart/making-input-images.md index dd7e6b32d5..0e32880752 100644 --- a/content/special-topics/darktable-chart/making-input-images.md +++ b/content/special-topics/darktable-chart/making-input-images.md @@ -12,7 +12,7 @@ There is a special situation if your camera automatically applies some lens corr To output your image go to the [export](../../module-reference/utility-modules/shared/export.md) module in the lighttable. -You will need to select “Lab” as the output color profile. This color space is not visible in the combobox by default. You first need to enable it by setting `allow_lab_output` to `TRUE` in darktable's configuration file `darktablerc` in the [configuration directory](../../preferences-settings/config-folder.md). Alternatively, you can start darktable with: +You will need to select “Lab” as the output color profile. This color space is not visible in the combobox by default. You first need to enable it by setting `allow_lab_output` to `TRUE` in darktable's configuration file `darktablerc` in the [configuration directory](../../preferences-settings/config-directory.md). Alternatively, you can start darktable with: ``` darktable --conf allow_lab_output=true diff --git a/content/special-topics/mem-performance.md b/content/special-topics/mem-performance.md index e2c2ec59fb..ddeea89b68 100644 --- a/content/special-topics/mem-performance.md +++ b/content/special-topics/mem-performance.md @@ -23,7 +23,7 @@ For most systems, tiling will probably only be used for full-sized image exports # performance tuning -There are a number of configuration parameters that can help you to fine-tune your system's performance. Some of these parameters are available in [preferences > processing > CPU / memory](../preferences-settings/processing.md#cpu--memory) and others need to be modified directly in darktable's configuration file (`darktablerc` in the darktable [configuration directory](../preferences-settings/config-folder.md)). +There are a number of configuration parameters that can help you to fine-tune your system's performance. Some of these parameters are available in [preferences > processing > CPU / memory](../preferences-settings/processing.md#cpu--memory) and others need to be modified directly in darktable's configuration file (`darktablerc` in the darktable [configuration directory](../preferences-settings/config-directory.md)). This section provides some guidance on how to adjust these settings. @@ -49,7 +49,7 @@ On the other hand darktable's performance during file exports is more or less on ## darktable resources -The "darktable resources" preference (in [preferences > processing > CPU / memory](../preferences-settings/processing.md#cpu--memory)) allows you to choose between four different approaches to allocating your system's resources to darktable. Each of these options controls multiple individual parameters, which are defined independently in `darktablerc` in the darktable [configuration directory](../preferences-settings/config-folder.md). You can amend any of these directly within your darktablerc file to tweak values for your selected resource level, though you cannot add your own custom resource level to the preferences drop-down. +The "darktable resources" preference (in [preferences > processing > CPU / memory](../preferences-settings/processing.md#cpu--memory)) allows you to choose between four different approaches to allocating your system's resources to darktable. Each of these options controls multiple individual parameters, which are defined independently in `darktablerc` in the darktable [configuration directory](../preferences-settings/config-directory.md). You can amend any of these directly within your darktablerc file to tweak values for your selected resource level, though you cannot add your own custom resource level to the preferences drop-down. Each of the four "darktable resources" options are defined as follows: diff --git a/content/special-topics/program-invocation/darktable.md b/content/special-topics/program-invocation/darktable.md index 6fffcd9a1e..671c924d49 100644 --- a/content/special-topics/program-invocation/darktable.md +++ b/content/special-topics/program-invocation/darktable.md @@ -56,10 +56,10 @@ All parameters are optional. In most cases darktable should be started without a : Prevent darktable from initializing the OpenCL subsystem. Use this option if darktable crashes at startup due to a defective OpenCL implementation. `--configdir ` -: Define the directory where darktable stores user-specific configuration. The default paths are listed in: [configuration directory](../../preferences-settings/config-folder.md) +: Define the directory where darktable stores user-specific configuration. The default paths are listed on the [configuration directory](../../preferences-settings/config-directory.md) page. `--library ` -: darktable keeps image information in an sqlite database for fast access. The default location of that database file is file name `library.db` in the directory specified by `--configdir` or the default [configuration directory](../../preferences-settings/config-folder.md). Use this option to provide an alternative location (e.g. if you want to do some experiments without compromising your original `library.db`). If the database file does not exist, darktable creates it for you. You may also provide `:memory:` as the library file, in which case the database is kept in system memory -- all changes are discarded when darktable terminates. +: darktable keeps image information in an sqlite database for fast access. The default location of that database file is file name `library.db` in the directory specified by `--configdir` or the default [configuration directory](../../preferences-settings/config-directory.md). Use this option to provide an alternative location (e.g. if you want to do some experiments without compromising your original `library.db`). If the database file does not exist, darktable creates it for you. You may also provide `:memory:` as the library file, in which case the database is kept in system memory -- all changes are discarded when darktable terminates. : Whenever darktable starts, it will lock the library to the current user. It does this by writing the current process identifier (PID) into a lock file `.lock` next to the library specified. If darktable finds an existing lock file for the library, it will terminate immediately. @@ -86,7 +86,7 @@ All parameters are optional. In most cases darktable should be started without a : Provide a json file that contains camera-specific noise profiles. The default location depends on your installation. Typical locations are `/opt/darktable/share/darktable/noiseprofile.json` and `/usr/share/darktable/noiseprofile.json`. `--conf =` -: darktable supports a rich set of configuration parameters defined by the user in file `darktablerc`, located in the directory specified by `--configdir` or the default [configuration directory](../../preferences-settings/config-folder.md). You may temporarily overwrite individual settings on the command line with this option -- these settings will not be stored in `darktablerc` on exit. +: darktable supports a rich set of configuration parameters defined by the user in file `darktablerc`, located in the directory specified by `--configdir` or the default [configuration directory](../../preferences-settings/config-directory.md). You may temporarily overwrite individual settings on the command line with this option -- these settings will not be stored in `darktablerc` on exit. `-t ` : limit number of openmp threads to use in openmp parallel sections. diff --git a/content/special-topics/program-invocation/purge_non_existing_images_sh.md b/content/special-topics/program-invocation/purge_non_existing_images_sh.md index c7e9e8b324..0b5451e90e 100644 --- a/content/special-topics/program-invocation/purge_non_existing_images_sh.md +++ b/content/special-topics/program-invocation/purge_non_existing_images_sh.md @@ -19,7 +19,7 @@ Run the script with no options to perform a "dry run", which generates a report The available options are: `-c|--configdir ` -: Specify the path to the darktable configuration directory to be used by the script. If this option is not provided, the default [configuration directory](../../preferences-settings/config-folder.md) location will be used. +: Specify the path to the darktable configuration directory to be used by the script. If this option is not provided, the default [configuration directory](../../preferences-settings/config-directory.md) location will be used. `-l|--library ` : Specify the path to the library.db database file to be analysed by the script. If this option is not specified, the default library.db file location will be used.