1 # More Detailed `make` Instructions 2 3 The full syntax of the `make` command is `<keyboard_folder>:<keymap>:<target>`, where: 4 5 * `<keyboard_folder>` is the path of the keyboard, for example `planck` 6 * Use `all` to compile all keyboards 7 * Specify the path to compile a revision, for example `planck/rev4` or `planck/rev3` 8 * If the keyboard doesn't have any folders, it can be left out 9 * To compile the default folder, you can leave it out 10 * `<keymap>` is the name of the keymap, for example `algernon` 11 * Use `all` to compile all keymaps 12 * `<target>` will be explained in more detail below. 13 14 The `<target>` means the following 15 * If no target is given, then it's the same as `all` below 16 * `all` compiles as many keyboard/revision/keymap combinations as specified. For example, `make planck/rev4:default` will generate a single .hex, while `make planck/rev4:all` will generate a hex for every keymap available to the planck. 17 * `dfu`, `teensy`, `avrdude`, `dfu-util` or `bootloadHID`, compile and upload the firmware to the keyboard. If the compilation fails, then nothing will be uploaded. The programmer to use depends on the keyboard. For most keyboards it's `dfu`, but for ChibiOS keyboards you should use `dfu-util`, and `teensy` for standard Teensys. To find out which command you should use for your keyboard, check the keyboard specific readme. 18 * **Note**: some operating systems need root access for these commands to work, so in that case you need to run for example `sudo make planck/rev4:default:dfu`. 19 * `clean`, cleans the build output folders to make sure that everything is built from scratch. Run this before normal compilation if you have some unexplainable problems. 20 21 You can also add extra options at the end of the make command line, after the target 22 23 * `make COLOR=false` - turns off color output 24 * `make SILENT=true` - turns off output besides errors/warnings 25 * `make VERBOSE=true` - outputs all of the gcc stuff (not interesting, unless you need to debug) 26 * `make EXTRAFLAGS=-E` - Preprocess the code without doing any compiling (useful if you are trying to debug #define commands) 27 28 The make command itself also has some additional options, type `make --help` for more information. The most useful is probably `-jx`, which specifies that you want to compile using more than one CPU, the `x` represents the number of CPUs that you want to use. Setting that can greatly reduce the compile times, especially if you are compiling many keyboards/keymaps. I usually set it to one less than the number of CPUs that I have, so that I have some left for doing other things while it's compiling. Note that not all operating systems and make versions supports that option. 29 30 Here are some examples commands 31 32 * `make all:all` builds everything (all keyboard folders, all keymaps). Running just `make` from the `root` will also run this. 33 * `make ergodox_infinity:algernon:clean` will clean the build output of the Ergodox Infinity keyboard. 34 * `make planck/rev4:default:dfu COLOR=false` builds and uploads the keymap without color output. 35 36 ## `rules.mk` Options 37 38 Set these variables to `no` to disable them, and `yes` to enable them. 39 40 `BOOTMAGIC_ENABLE` 41 42 This allows you to hold a key and the salt key (space by default) and have access to a various EEPROM settings that persist over power loss. It's advised you keep this disabled, as the settings are often changed by accident, and produce confusing results that makes it difficult to debug. It's one of the more common problems encountered in help sessions. 43 44 Consumes about 1000 bytes. 45 46 `MOUSEKEY_ENABLE` 47 48 This gives you control over cursor movements and clicks via keycodes/custom functions. 49 50 `EXTRAKEY_ENABLE` 51 52 This allows you to use the system and audio control key codes. 53 54 `CONSOLE_ENABLE` 55 56 This allows you to print messages that can be read using [`hid_listen`](https://www.pjrc.com/teensy/hid_listen.html). 57 58 By default, all debug (*dprint*) print (*print*, *xprintf*), and user print (*uprint*) messages will be enabled. This will eat up a significant portion of the flash and may make the keyboard .hex file too big to program. 59 60 To disable debug messages (*dprint*) and reduce the .hex file size, include `#define NO_DEBUG` in your `config.h` file. 61 62 To disable print messages (*print*, *xprintf*) and user print messages (*uprint*) and reduce the .hex file size, include `#define NO_PRINT` in your `config.h` file. 63 64 To disable print messages (*print*, *xprintf*) and **KEEP** user print messages (*uprint*), include `#define USER_PRINT` in your `config.h` file. 65 66 To see the text, open `hid_listen` and enjoy looking at your printed messages. 67 68 **NOTE:** Do not include *uprint* messages in anything other than your keymap code. It must not be used within the QMK system framework. Otherwise, you will bloat other people's .hex files. 69 70 Consumes about 400 bytes. 71 72 `COMMAND_ENABLE` 73 74 This enables magic commands, typically fired with the default magic key combo `LSHIFT+RSHIFT+KEY`. Magic commands include turning on debugging messages (`MAGIC+D`) or temporarily toggling NKRO (`MAGIC+N`). 75 76 `SLEEP_LED_ENABLE` 77 78 Enables your LED to breath while your computer is sleeping. Timer1 is being used here. This feature is largely unused and untested, and needs updating/abstracting. 79 80 `NKRO_ENABLE` 81 82 This allows the keyboard to tell the host OS that up to 248 keys are held down at once (default without NKRO is 6). NKRO is off by default, even if `NKRO_ENABLE` is set. NKRO can be forced by adding `#define FORCE_NKRO` to your config.h or by binding `MAGIC_TOGGLE_NKRO` to a key and then hitting the key. 83 84 `BACKLIGHT_ENABLE` 85 86 This enables the in-switch LED backlighting. You can specify the backlight pin by putting this in your `config.h`: 87 88 #define BACKLIGHT_PIN B7 89 90 `MIDI_ENABLE` 91 92 This enables MIDI sending and receiving with your keyboard. To enter MIDI send mode, you can use the keycode `MI_ON`, and `MI_OFF` to turn it off. This is a largely untested feature, but more information can be found in the `quantum/quantum.c` file. 93 94 `UNICODE_ENABLE` 95 96 This allows you to send Unicode characters using `UC(<code point>)` in your keymap. Code points up to `0x7FFF` are supported. This covers characters for most modern languages, as well as symbols, but it doesn't cover emoji. 97 98 `UNICODEMAP_ENABLE` 99 100 This allows you to send Unicode characters using `X(<map index>)` in your keymap. You will need to maintain a mapping table in your keymap file. All possible code points (up to `0x10FFFF`) are supported. 101 102 `UCIS_ENABLE` 103 104 This allows you to send Unicode characters by inputting a mnemonic corresponding to the character you want to send. You will need to maintain a mapping table in your keymap file. All possible code points (up to `0x10FFFF`) are supported. 105 106 For further details, as well as limitations, see the [Unicode page](feature_unicode.md). 107 108 `BLUETOOTH_ENABLE` 109 110 This allows you to interface with a Bluefruit EZ-key to send keycodes wirelessly. It uses the D2 and D3 pins. 111 112 `AUDIO_ENABLE` 113 114 This allows you output audio on the C6 pin (needs abstracting). See the [audio page](feature_audio.md) for more information. 115 116 `FAUXCLICKY_ENABLE` 117 118 Uses buzzer to emulate clicky switches. A cheap imitation of the Cherry blue switches. By default, uses the C6 pin, same as `AUDIO_ENABLE`. 119 120 `VARIABLE_TRACE` 121 122 Use this to debug changes to variable values, see the [tracing variables](unit_testing.md#tracing-variables) section of the Unit Testing page for more information. 123 124 `API_SYSEX_ENABLE` 125 126 This enables using the Quantum SYSEX API to send strings (somewhere?) 127 128 This consumes about 5390 bytes. 129 130 `KEY_LOCK_ENABLE` 131 132 This enables [key lock](feature_key_lock.md). This consumes an additional 260 bytes. 133 134 `SPLIT_KEYBOARD` 135 136 This enables split keyboard support (dual MCU like the let's split and bakingpy's boards) and includes all necessary files located at quantum/split_common 137 138 `SPLIT_TRANSPORT` 139 140 As there is no standard split communication driver for ARM-based split keyboards yet, `SPLIT_TRANSPORT = custom` must be used for these. It will prevent the standard split keyboard communication code (which is AVR-specific) from being included, allowing a custom implementation to be used. 141 142 `CUSTOM_MATRIX` 143 144 Lets you replace the default matrix scanning routine with your own code. You will need to provide your own implementations of matrix_init() and matrix_scan(). 145 146 `DEBOUNCE_TYPE` 147 148 Lets you replace the default key debouncing routine with an alternative one. If `custom` you will need to provide your own implementation. 149 150 ## Customizing Makefile Options on a Per-Keymap Basis 151 152 If your keymap directory has a file called `rules.mk` any options you set in that file will take precedence over other `rules.mk` options for your particular keyboard. 153 154 So let's say your keyboard's `rules.mk` has `BACKLIGHT_ENABLE = yes`. You want your particular keyboard to not have the backlight, so you make a file called `rules.mk` and specify `BACKLIGHT_ENABLE = no`.