10.2. User Tree Layout
Prev | 10. System and User NsCDE Tree Layout | Next

### 10.2. User Tree Layout

User part of configuration is located in `$HOME/.NSCDE` - this place is what is referred as `$FVWM_USERDIR` in this documentation. If user has a plain FVWM configuration in `$HOME/.fvwm` it will not be used in any way and can co-exist with NsCDE. Here is the simple layout of things in `$FVWM_USERDIR`:

- `app-defaults/` directory:

  X resources referenced by the usual `XAPPLRESDIR` environment variable. Files inside are (will be) generated by the Color Style Manager

- `backdrops/` directory:

  If created, user can put custom backdrop sources here, and they can than be selected by the Backdrop Style Manager and processed with current or custom color scheme.

- `photos/` directory:

  User's photos which can be used instead of backdrops if selected in Backdrop Style Manager or configured in `Backdrops.fvwmgen` manually.

- `backer/` directory:

  Generated backdrops referenced by Colorsets 31-38 for FvwmBacker. This is what is displayed on the screen background, different for every workspace.

- `backer/bgcache/` subdirectory:

  If FVWM3 is used by NsCDE in non-global monitor DesktopConfiguration mode, Large PNG files are generated from the existing backdrops in `$NSCDE_DATADIR/defaults/backer`. This directory contains automatically generated hierachy structure of background cache for multiple different X RandR monitors when NsCDE is used with FVWM3 in non-global `DesktopConfiguration` mode, which are matching various combinations of desks across monitors. Referenced in function f_SetFvwm3NonGlobalBackground of `fvwm/Functions.fvwmconf` and in `$NSCDE_TOOLSDIR/xrandr_backer` backdrop autocreate script.

- `fontsets/` directory:

  If created, user can put or generate with Font Style Manager own fontsets here.

- `icons/` directory:

  Populated by dynamic menu action fvwm-menu-desktop. If directory does not exist, script will create it.

- `icons/NsCDE/` directory:

  NsCDE custom icons. Put here by Color Style Manager and the rest of the tools. Since icons from here are referenced with a relative path, whatever is missing here, will be loaded from system's `$NSCDE_DATADIR/icons/NsCDE` automatically.

- `libexec/` directory:

  If created, `colormgr.local` script can be written and put here, as well as `fontmgr.local` and other user's hooks. This is done with reasonable defaults for `colormgr.local` during the initial setup of the new NsCDE profile.

- `palettes/` directory:

  User can put custom palette files here, and they can than be selected by the Color Style Manager and processed for a preview or applied as new theme.

- `templates/` directory:

  Here, local subdirectory of `app-defaults` with tmpl files can be optionally created. Also, it is a good choice for Gkrellm or other files processed by the `libexec/colormgr.local`

- `tmp/` directory:

  Place used by parts of the NsCDE and in particular NsCDE's FvwmScript programs for temporary generated files for previews, or as scratch and work directory. Tools are usually taking care to cleanup their garbage from tmp/ on exit.

- `XYZ.fvwmconf` files:

  Absolute overrides of `$NSCDE_DATADIR/fvwm/XYZ.fvwmconf` files. If in existence, they will be read instead of system defaults. XYZ is here placeholder/example for Style, Functions, Keybindings, Init, Menus etc ... For some groups of FVWM configuration points this makes a sense, for most it doesn't see next description for such examples.

- `XYZ.fvwmlocal` files:

  Extensions, added values of `$NSCDE_DATADIR/fvwm/XYZ.fvwmconf` files. If in existence, they will be read right as the continuation of their .fvwmconf main configurations from system (or local) directory. This is preferred way to extend functionality or override something not big enough for a complete "fork" of the config file. Colorset, Backdrops, Animate, Font-$DPIdpi, Init, and Subpanel are exception of this, that is, it is preferred (if not only thing possible) to have it as .fvwmconf files only, and not .fvwmlocal files.

  `Style.override` file:

  If created, it will be read by the `$NSCDE_DATADIR/fvwm/Style.fvwmconf`. Here, core style for all windows (*) can be overriden prior to reading particular NsCDE application style overrides and addons, and prior to reading `$FVWM_USERDIR/Style.fvwmlocal`. Here, advanced users can override or extend core styles which are not customizable by the Window Style Manager. See fvwm(1) for a huge list of Style options. Putting core Style options after NsCDE applications in the `$NSCDE_DATADIR/fvwm/Style.fvwmconf` are processed can nullify overrides for that particular applications, this is why this mechanism is provided. This file is not created in `$FVWM_USERDIR` by setup procedure or Style Managers, but if created (manually) it will be read and processed.

  XYZ is here placeholder/example for Style, Functions, Keybindings, Init, Menus etc ...

- `NsCDE.conf` file:

  managed by Window Style Manager, Workspaces and Pages Style Manager, Pointer Style Manager and users own editor manually. See the rest of the documentation. `NsCDE.conf` may be considered the most important user configuration NsCDE file.

- `WSM.conf` file:

  read/written by Workspaces and Pages Style Manager, and Graphical Workspace Manager (GWM) Options dialog, and user's favorite editor. Not an FVWM config file. System default of this file is `$NSCDE_DATADIR/defaults/WSM.conf`, and it is not actively used, because defaults are hardcoded in WSM and GWM.

- `FrontPanel.actions` file:

  user's overrides/addons for Front Panel icons and actions. Written by editor manually, by Copy to Main Panel, Move Button Left/Right options of the context submenu of subpanel's items. See section about Front Panel for more information.

- `GeoDB.ini` file:

  part of the Geometry Manager functionality. Written and read by the $NSCDE_TOOLSDIR/confset and $NSCDE_TOOLSDIR/confget on Save Geometry" and Reposition from Extended and Standard Window Operations menus. Windows-like ini files are WAY nicer than dconf and such binary registry-like facilities. See detals about Geometry Manager for more information.

- `Xdefaults` file:

  Read on startup by xrdb(1).

- `Xdefaults.local`, `Xdefaults.fontdefs`, `Xdefaults.mouse` files:

  Included with preprocessor directives from `Xdefaults`

- `Xset.conf` file:

  Configuration (a batch file or shell script basically) with xset(1) parameters for system beep, pointer, keyboard, and DPMS settings which are managed by their respective Style Managers. User can put here setxkbmap, xgamma and such additional X server configuration commands (or whatever one likes). Care must be taken not to mess lines beggining with #XYZMgr,xxxx till #end, since this is internal marker of FvwmScript's buggy `WriteToFile` function.

- `NsCDE-Sandbox.conf` file:

  If exists, used only in bare sandbox mode, where basic functionality of the NsCDE is needed, and not full DE-like environment.

Prev | Up | Next
10. System and User NsCDE Tree Layout | Home | 11. Installation Dependencies