sites

public wiki contents of suckless.org
git clone git://git.suckless.org/sites
Log | Files | Refs

index.md (2022B)


      1 Customisation
      2 =============
      3 **dwm** is customised by editing **config.h**, a C language header file, and
      4 **config.mk**, a Make include file.
      5 
      6 What is config.h?
      7 -----------------
      8 config.h is a source code file which is included by dwm.c, the main dwm source
      9 code module. It serves as the configuration file for all of dwm's features,
     10 e.g., application placement, tags, and colours. A vanilla download of dwm will
     11 contain a file called config.def.h, a template you can use to create your own
     12 config.h file. To start customising dwm, simply copy config.def.h into config.h
     13 before you run make.
     14 
     15 What is config.mk?
     16 ------------------
     17 config.mk is a file included by Makefile. It allows you to configure how make
     18 is going to compile and install dwm.
     19 
     20 How do I modify config.h?
     21 -------------------------
     22 config.h can be edited just like any other C source code file. It contains
     23 definitions of variables that are going to be used by dwm.c and therefore it is
     24 vital that the file is always up to date. The default Makefile distributed with
     25 dwm will not overwrite your customised config.h with the contents of
     26 config.def.h, even if it was updated in the latest git pull. Therefore, you
     27 should always compare your customised config.h with config.def.h and make sure
     28 you include any changes to the latter in your config.h.
     29 
     30 How do I modify **config.mk**?
     31 ------------------------------
     32 config.mk can be edited just like any other text file. It contains definitions
     33 of variables that are going to be used inside Makefile. Unlike config.h,
     34 config.mk does not have a config.def.mk (a default Makefile). Therefore, during
     35 an update of your repository you may run into conflicts if the original
     36 config.mk is edited.
     37 
     38 Are there any example customisations to get me started?
     39 -------------------------------------------------------
     40 Various customisation options are illustrated in the sub-directories of this
     41 wiki page. Under each of the categories (customfuncs, fonts, etc.,) you will
     42 find example modifications that will get you started.