Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/lua/a-simple-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-directory.md) and add the following line to it:

```
print("Hello World !")
Expand Down
4 changes: 1 addition & 3 deletions content/lua/basic-principles.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-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.

Expand Down
2 changes: 1 addition & 1 deletion content/lua/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-directory.md) page.

### Linux Package, AppImage and Flatpak

Expand Down
5 changes: 3 additions & 2 deletions content/lua/sharing-scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down Expand Up @@ -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-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.

- Make sure to declare all your functions as `local` so as not to pollute the general namespace.
Expand Down
2 changes: 1 addition & 1 deletion content/module-reference/processing-modules/crop-rotate.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-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.

Expand Down
2 changes: 1 addition & 1 deletion content/module-reference/processing-modules/crop.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-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`

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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-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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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-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.

Expand Down
2 changes: 1 addition & 1 deletion content/module-reference/processing-modules/watermark.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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-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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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`
Expand Down
4 changes: 2 additions & 2 deletions content/preferences-settings/general.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-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 `$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-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.

Expand Down
2 changes: 1 addition & 1 deletion content/preferences-settings/lighttable.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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-directory.md). Alternatively, you can start darktable with:

```
darktable --conf allow_lab_output=true
Expand Down
Loading