├── uninstall.sh ├── Makefile ├── autostart.sh ├── install.sh ├── src ├── msiklm.h ├── msiklm.c └── main.c ├── README.md └── LICENSE /uninstall.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # removes the program by deleting it from /usr/local/bin 4 | if [ -f '/usr/local/bin/msiklm' ]; then 5 | sudo rm -v '/usr/local/bin/msiklm' 6 | 7 | if [ -f './autostart.sh' ]; then 8 | sudo ./autostart.sh --disable 9 | fi 10 | 11 | echo "All components of 'msiklm' were successfully removed!" 12 | else 13 | echo "Nothing to remove because 'msiklm' is not installed!" 14 | fi 15 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | ############################################################################# 2 | # Makefile for building MSI Keyboard Light Manager (MSIKLM) 3 | ############################################################################# 4 | 5 | ####### Compiler, tools and options 6 | TARGET = msiklm 7 | CC = gcc 8 | CFLAGS = -m64 -pipe -O3 -Wall -W -D_REENTRANT 9 | LFLAGS = -m64 -Wl,-O3 10 | LIBS = -lhidapi-libusb 11 | DEL_FILE = rm -f 12 | INSTALLPREFIX = /usr/local/bin 13 | 14 | ####### Files 15 | INC_DIR = src 16 | INC_FILE = msiklm.h 17 | 18 | SRC_DIR = src 19 | SRC_FILE = main.c \ 20 | msiklm.c 21 | 22 | OBJ_DIR = .obj 23 | OBJ_FILE = $(SRC_FILE:.c=.o) 24 | 25 | CRT_DIR = . 26 | 27 | SRC = $(addprefix $(SRC_DIR)/,$(SRC_FILE)) 28 | INC = $(addprefix $(INC_DIR)/,$(INC_FILE)) 29 | OBJ = $(addprefix $(OBJ_DIR)/,$(OBJ_FILE)) 30 | CRT = $(addprefix $(OBJ_DIR)/,$(CRT_DIR)) 31 | 32 | ####### Build rules 33 | 34 | all: $(TARGET) 35 | 36 | $(OBJ_DIR)/%.o: $(SRC_DIR)/%.c $(INC) Makefile 37 | @mkdir -p $(CRT) 2> /dev/null || true 38 | $(CC) $(CFLAGS) -c $< -o $@ 39 | 40 | $(TARGET): $(OBJ) 41 | $(CC) $(LFLAGS) -o $(TARGET) $(OBJ) $(LIBS) 42 | 43 | clean: 44 | $(DEL_FILE) $(OBJ) 45 | $(DEL_FILE) -r $(OBJ_DIR) 46 | 47 | delete: clean 48 | $(DEL_FILE) $(TARGET) 49 | 50 | install: all 51 | @cp -v $(TARGET) $(INSTALLPREFIX)/$(TARGET) 52 | @chmod 755 $(INSTALLPREFIX)/$(TARGET) 53 | 54 | re: delete all 55 | 56 | .PHONY: all clean delete re 57 | -------------------------------------------------------------------------------- /autostart.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # to enable the autostart, execute this script with your configuration of choice (same arguments as used for 'msiklm') 4 | # this script will create a file '/etc/udev/rules.d/90-msiklm.rules' to activate the respective configuration at startup or wakeup 5 | # further, this script can also undo this by calling it with the '--disable' argument 6 | 7 | if [ $# -eq 0 ]; then 8 | echo 'At least one argument is required' 9 | exit 1 10 | fi 11 | 12 | # location of the MSIKLM binary (maybe adjust this according to your install target) 13 | msiklm='/usr/local/bin/msiklm' 14 | 15 | # the rules file 16 | file='/etc/udev/rules.d/90-msiklm.rules' 17 | 18 | # autostart requires 'msiklm' to be installed 19 | if [ ! -f $msiklm ]; then 20 | echo 'MSI Keyboard Light Manager is not installed, hence no autostart possible' 21 | exit 1 22 | fi 23 | 24 | if [ "$1" != '--disable' ]; then 25 | # activate the autostart 26 | 27 | if (sudo $msiklm $@); then 28 | echo 'Activating MSIKLM autostart...' 29 | sleep 1 30 | 31 | # redirection with '>' or '>>' takes place before 'sudo' is applied, hence not directly usable here 32 | run="ACTION==\"add\", ATTRS{idVendor}==\"1770\", ATTRS{idProduct}==\"ff00\", RUN+=\"$msiklm " # trailing space since the arguments will be added 33 | for arg in "$@"; do 34 | run="$run '$arg'" 35 | done 36 | run="$run\""; 37 | 38 | sudo sh -c "echo '# run MSIKLM to configure the keyboard illumination' > $file" 39 | echo $run | sudo tee -a $file > /dev/null 40 | 41 | sudo chmod 644 $file 42 | 43 | echo "Autostart rules file '$file' created" 44 | else 45 | echo "Input arguments are not valid for 'msiklm', use 'msiklm help' to get an overview of valid arguments" 46 | exit 1 47 | fi 48 | else 49 | # deactivate the autostart 50 | 51 | echo 'Deactivating MSIKLM autostart...' 52 | sleep 1 53 | 54 | if [ -f $file ]; then 55 | echo 'Removing autostart rules file...' 56 | sleep 1 57 | 58 | sudo rm -v $file 59 | fi 60 | fi 61 | -------------------------------------------------------------------------------- /install.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # script to automatically do the following steps: 4 | # - install the dependencies to compile the program, i.e. install 'gcc', 'make' and 'libhidapi-dev' 5 | # remark: once the program is compiled, 'libhidapi-dev' isn't required any more, only 'libhidapi-libusb0' is 6 | # - compile the program 7 | # - move the program 'msiklm' to '/usr/local/bin/msiklm' 8 | # - run 'msiklm' with 'test' option to check if the keyboard is detected 9 | 10 | echo 'Installation script for MSIKLM - MSI Keyboard Light Manager' 11 | echo '###########################################################' 12 | sleep 1 13 | 14 | echo 'Installing dependencies...' 15 | sleep 2 16 | 17 | if (sudo apt install -y gcc make libhidapi-dev); then 18 | echo 'Dependencies successfully installed' 19 | sleep 2 20 | elif (sudo dnf install -y gcc make hidapi-devel); then 21 | echo 'Dependencies successfully installed' 22 | sleep 2 23 | elif (sudo yum install -y gcc make hidapi-devel); then 24 | echo 'Dependencies successfully installed' 25 | sleep 2 26 | elif (sudo pacman -S --noconfirm gcc make hidapi); then 27 | echo 'Dependencies successfully installed' 28 | sleep 2 29 | elif (sudo zypper install gcc make libhidapi-devel); then 30 | echo 'Dependencies successfully installed' 31 | sleep 2 32 | else 33 | echo 'Dependencies could not be installed' 34 | exit 1 35 | fi 36 | 37 | echo 'Compiling MSIKLM...' 38 | sleep 2 39 | 40 | # compile 41 | if (make); then 42 | echo 'Compiling finished successfully' 43 | sleep 2 44 | else 45 | echo 'Compiling failed' 46 | exit 1 47 | fi 48 | 49 | # install 'msiklm' to '/usr/local/bin/msiklm' which also makes it callable via the msiklm command 50 | if (sudo make install); then 51 | make delete 52 | echo 'Installation of MSIKLM finished successfully' 53 | sleep 2 54 | else 55 | echo 'Installation of MSIKLM failed' 56 | exit 1 57 | fi; 58 | 59 | echo 'Testing MSIKLM...' 60 | sleep 1 61 | 62 | if (sudo msiklm test); then 63 | echo "To configure the keyboard run 'msiklm' with your configuartion of choice, for a list of valid commands run 'msiklm help'." 64 | echo "If you want to enable the autostart, run 'autostart.sh' with your configuartion of choice, to uninstall 'msiklm' run 'uninstall.sh'." 65 | echo 'Thank you for using MSIKLM and have fun with it! :-)' 66 | else 67 | echo 'Testing of MSIKLM failed' 68 | fi 69 | -------------------------------------------------------------------------------- /src/msiklm.h: -------------------------------------------------------------------------------- 1 | /** 2 | * @file msiklm.h 3 | * 4 | * @brief header file for the controller functions to configure the SteelSeries keyboard in MSI gaming notebooks 5 | */ 6 | 7 | #ifndef MSIKLM_H 8 | #define MSIKLM_H 9 | 10 | #ifdef _WIN32 11 | #define strtok_r(s,d,p) strtok_s(s,d,p) 12 | #endif 13 | 14 | #include 15 | #include 16 | 17 | typedef unsigned char byte; 18 | 19 | /** 20 | * @brief color profile enum: the color profile either defines a default color or indicates a custom selection 21 | */ 22 | enum color_profile 23 | { 24 | none = 0, 25 | red = 1, 26 | orange = 2, 27 | yellow = 3, 28 | green = 4, 29 | sky = 5, 30 | blue = 6, 31 | purple = 7, 32 | white = 8, 33 | custom = 64 //custom rgb-color selection (64 defines the keyboard's rgb-command) 34 | }; 35 | 36 | /** 37 | * @brief color struct: each color is represented by a profile value and its respective rgb-values 38 | */ 39 | struct color 40 | { 41 | enum color_profile profile; 42 | byte red; 43 | byte green; 44 | byte blue; 45 | }; 46 | 47 | /** 48 | * @brief region enum: each value refers to a region whose color could be set 49 | */ 50 | enum region 51 | { 52 | left = 1, 53 | middle = 2, 54 | right = 3, 55 | logo = 4, 56 | front_left = 5, 57 | front_right = 6, 58 | mouse = 7 59 | }; 60 | 61 | /** 62 | * @brief brightness enum: the brightness is either defined by the rgb selection or one of four predefined values 63 | */ 64 | enum brightness 65 | { 66 | high = 0, 67 | medium = 1, 68 | low = 2, 69 | off = 3, 70 | rgb = custom //brightness defined by custom rgb-color selection 71 | }; 72 | 73 | /** 74 | * @brief modes enum (where a mode is an animation or some kind of special effect) 75 | */ 76 | enum mode 77 | { 78 | normal = 1, 79 | gaming = 2, 80 | breathe = 3, 81 | demo = 4, 82 | wave = 5 83 | }; 84 | 85 | 86 | /** 87 | * @brief parses a string into a color value 88 | * @param color_str the color value as a string (red, green, blue, etc.), hex code (0xFFFFFF) or in [r;g;b] notation where r;g;b are the respective channel values 89 | * @param result the parsed color 90 | * @returns 0 if parsing succeeded, -1 on error 91 | */ 92 | int parse_color(const char* color_str, struct color* result); 93 | 94 | /** 95 | * @brief parses a string into a brightness value 96 | * @param brightness_str the brightness value as a string 97 | * @returns the parsed brightness value or -1 if the string is not a valid brightness 98 | */ 99 | enum brightness parse_brightness(const char* brightness_str); 100 | 101 | /** 102 | * @brief parses a string into a mode value 103 | * @param mode_str the mode value as a string 104 | * @returns the parsed mode value or -1 if the string is not a valid mode 105 | */ 106 | enum mode parse_mode(const char* mode_str); 107 | 108 | /** 109 | * @brief tries to open the MSI gaming notebook's SteelSeries keyboard and if it succeeds, it will be closed 110 | * @returns true, if the keyboard could be opened, false otherwise 111 | */ 112 | bool keyboard_found(); 113 | 114 | /** 115 | * @brief tries to open the MSI gaming notebook's SteelSeries keyboard 116 | * @returns a corresponding hid_device, null if the keyboard was not detected 117 | */ 118 | hid_device* open_keyboard(); 119 | 120 | /** 121 | * @brief sets the selected color for a specified region (the colors will only be set as soon as set_mode() is called in advance) 122 | * @param dev the hid device 123 | * @param color the color value 124 | * @param region the region where the color should be set 125 | * @param brightness the selected brightness (note that it also defines the kind of command that is send to the keyboard) 126 | * @returns the actual number of bytes written, -1 on error 127 | */ 128 | int set_color(hid_device* dev, struct color color, enum region region, enum brightness brightness); 129 | 130 | /** 131 | * @brief sets the selected mode 132 | * @param dev the hid device 133 | * @param mode the selected mode 134 | * @returns the actual number of bytes written, -1 on error 135 | */ 136 | int set_mode(hid_device* dev, enum mode mode); 137 | 138 | /** 139 | * @brief utility function for hex code parsing 140 | * @param hex the hex code in question 141 | * @returns the parsed integer value 142 | */ 143 | int parse_hex(unsigned char hex); 144 | 145 | #endif //MSIKLM_H 146 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # General 2 | 3 | The MSI Keyboard Light Manager (MSIKLM) is an easy-to-use tool that allows to configure the 4 | SteelSeries keyboards of MSI gaming notebooks with Linux / Unix in almost the same way as the 5 | SteelSeries Engine can do using Windows. 6 | 7 | 8 | # Installation & Requirements 9 | ## Manual Installation 10 | 11 | I tried to keep the external dependencies to a minimum level, however there are some unavoidable 12 | ones. These are: 13 | 14 | * GCC - the C compiler 15 | * make - the main build tool of the Linux world 16 | * LIBUSB - MSIKLM needs to communicate with the keyboard, for this LIBUSB is required 17 | 18 | Besides there are no others, no Qt, no Java, not even a C++ compiler is required. To install the 19 | program on any Debian-based Linux distribution (for instance any Ubuntu-based one), there is an 20 | installation script `install.sh` which can be run by opening the respective folder in a terminal 21 | and typing 22 | 23 | ./install.sh 24 | 25 | or if there are any problems you can try 26 | 27 | bash install.sh 28 | 29 | as well which most certainly will work on most Debian-based distributions. This script will do the 30 | following steps, if you do not want to use the installation script for some reason, you can use the 31 | manual commands instead: 32 | 33 | * installation of the dependencies 34 | ``` 35 | sudo apt install -y gcc make libhidapi-dev 36 | ``` 37 | 38 | * compiling of MSIKLM 39 | ``` 40 | make 41 | ``` 42 | 43 | * clean up 44 | ``` 45 | make clean 46 | ``` 47 | 48 | * copy the built program to '/usr/local/bin/msiklm' and set its permissions 49 | ``` 50 | sudo mv -fv msiklm /usr/local/bin/msiklm 51 | sudo chmod 755 /usr/local/bin/msiklm 52 | ``` 53 | 54 | * test the connection 55 | ``` 56 | sudo msiklm test 57 | ``` 58 | 59 | Whenever MSIKLM is used, it should always be run as root because otherwise, the communication with 60 | the keyboard is not possible, hence always use the sudo prefix (only `msiklm help` will work as 61 | non-root). 62 | 63 | ## Distribution Package 64 | 65 | Currently, there are also the following packages available to install MSIKLM: 66 | 67 | * Arch Linux via the AUR repository : https://aur.archlinux.org/packages/msiklm-git/ 68 | 69 | * FreeBSD via the FreeBSD package repository : https://www.freshports.org/sysutils/msiklm/ 70 | ``` 71 | pkg install msiklm 72 | ``` 73 | 74 | 75 | # Usability 76 | 77 | MSIKLM is a pure command line application, however its keyboard illumination control functionality 78 | is encapsulated such that it could easily be integrated into a graphical user interface. However, 79 | I neither wrote one for it nor I plan to do so. It is quite easy to use, and here is how to use 80 | it. It always has to be called with at least one argument, i.e. running it without one will result 81 | in an error. Here is an overview over the valid commands: 82 | 83 | |command | valid arguments | example | 84 | |--------------------------------------------------------------|------------------------------------------------------------------------------------------------|--------------------------------------| 85 | |sudo msiklm \ | either a predefined color or arbitrary RGB values ([R;G;B] or hex code), cf. explanation below | sudo msiklm green | 86 | |sudo msiklm \[,\,\,\,...] | same as single color (important: no space between the colors!), cf. explanation below | sudo msiklm green,blue,red | 87 | |sudo msiklm \ | normal, gaming, breathe, demo, wave | sudo msiklm wave | 88 | |sudo msiklm \ \ | color as above, brightness can be off, low, medium, high, rgb | sudo msiklm green high | 89 | |sudo msiklm \ \ | same as above | sudo msiklm green,blue,red wave | 90 | |sudo msiklm \ \ \ | same as above | sudo msiklm green,blue,red high wave | 91 | 92 | The predefined supported colors are: none, off (equivalent to none), red, orange, yellow, green, 93 | sky, blue, purple and white. The color configuration can also be performed in an more advanced way: 94 | At most seven zones are supported (as long as supported by your device) and the respective colors 95 | have to be supplied in the following order: left, middle, right, logo, front_left, front_right and 96 | mouse. If there is only one supplied color, it is reused for the first three zones, the remaining 97 | ones stay unchanged (i.e. green as single argument is equivalent to green,green,green). The colors 98 | have to be separated with no spaces between the colors, simply add a comma for a new zone. The last 99 | four colors are fully optional, i.e. they are set if and only if they are supplied. Consequently, 100 | if you want to change the last color (mouse), you have to specify a color for all zones. Instead of 101 | a predefined color, each color can alternatively be set in full RGB notation; the color values have 102 | to be either enclosed by brackets and separated by semicolons, e.g. 'green' is equivalent to using 103 | [0;255;0], or hex code notation can be used (0x000000 to 0xFFFFFF) where the respective values have 104 | to be selected accordingly. It is possible to mix these explicit color definitions with predefined 105 | ones, e.g. you can select a custom color for the left zone and use predefined for the others by 106 | supplying [R;G;B],green,blue. Please note that it might be necessary to put quotation marks around 107 | explicit color definitions, otherwise the argument might not be properly processed by the shell. 108 | 109 | Further, the brightness argument can only be set to low, medium and high if _no_ custom rgb color is 110 | given, while not supplying it is equivalent to supply 'rgb'. The reason for this is two-fold: First, 111 | it makes little to no sense to explicitly define the color and to give a brightness as well, second 112 | the brightness can be used to switch to a different way of communicating with the keyboard. Besides 113 | technical details (cf. `set_color()` in `msiklm.c` for further details if you are interested in 114 | them), it improves the compatibility with different devices, however the brightness has to be 115 | explicitly given. For example `sudo msiklm green` will set the color green using its rgb values 116 | (i.e. red=0, green=255, blue=0 or 0x00FF00 in hex code notation) while `sudo msiklm green high` 117 | does basically the same but using a different way which might be supported by keyboards that do not 118 | support full rgb color selection. As I do not have a bunch of different notebook available to test 119 | them, I cannot say which command will work at which keyboard. 120 | 121 | Additionally, there are three extra commands that might be useful if something does not work: 122 | 123 | msiklm help -> shows the program's help 124 | sudo msiklm test -> tests if a compatible keyboard is found 125 | sudo msiklm list -> lists all found hid devices, this might be helpful if your keyboard is not detected by MSIKLM 126 | 127 | 128 | # Device Support 129 | 130 | Over the years, several keyboards were released out of which some are supported by msiklm while 131 | some others are not. As multiple issues were reported regarding device support, also a few aspects 132 | regarding device support are important. First, this project is a volunteer free-time / non-profit 133 | project that is not officially supported by MSI or SteelSeries. I started this project as there 134 | was no easy way to configure the keyboard whose command structure was known. Furthermore, two kinds 135 | of command structures were generally available while some keyboards seem to support only one, while 136 | some others might supported both. I have no official information whether certain keyboards are 137 | supported or not. As a rule of thumb, the chances are pretty high that it is if `sudo mskilm test` 138 | reports success. Otherwise, the chances are not that high. Still, the following things can be 139 | tested: 140 | 141 | - Run `sudo mskilm list` to list all USB devices. 142 | - If your keyboard is found, copy vendor ID and device ID. 143 | - Edit the file `msiklm.c` and replace the IDs in the line `hid_open(0x1770, 0xff00, 0);`, 144 | i.e. `0x1770` by your vendor ID and `0xff00` by your product ID, respectively. 145 | - Recompile msiklm with your changes. 146 | - Run `sudo mskilm test` again. 147 | 148 | Now, your device should be detected. Still, this does not mean that it also supports the currently 149 | implemented commands. I do not know whether it does, the only way to find out is to test on your 150 | own, in particular on your own risk. However, I think the risk is rather low that a wrong command 151 | can cause any damage to the keyboard. Presumably, at most a power-off might be required if 152 | something is wrong with the command. If you want to test msiklm with your modification, run a 153 | command of choice. Here, supplying and not supplying the intensity argument is worth testing as 154 | this selects the command structure out of two possible options, as discussed before. 155 | 156 | If this does not work with your keyboard, the only way of using it in combination with msiklm is 157 | to identify the correct command structure. Most likely, this is possible by dumping and analyzing 158 | the communication with the keyboard while it is controlled by the SteelSeries Engine. 159 | 160 | 161 | # Autostart 162 | 163 | An important additional feature is the optional autostart functionality since the keyboard will 164 | reset itself to its default color configuration whenever you reboot it or resume from standby. 165 | Hence, it is really useful to automatically reconfigure the keyboard to your configuration of 166 | choice. To do this, there is an extra script called `autostart.sh` that can do this for you. This 167 | script registers MSIKLM to the udev service (more precisely it registers the keyboard to the udev 168 | service which calls MSIKLM as soon as the keyboard is detected) by creating a rule file: 169 | 170 | /etc/udev/rules.d/90-msiklm.rules 171 | 172 | To create this file including your MSIKLM arguments of choice, run: 173 | 174 | ./autostart.sh 175 | 176 | Try if everything works by first rebooting your system and then try a standby and wakeup. If 177 | everything works, we are done here. If not, please report an issue. :-) 178 | 179 | Finally, the autostart can be disabled by running 180 | 181 | ./autostart.sh --disable 182 | 183 | which will disable the autostart by removing the rule file. 184 | 185 | 186 | # Uninstallation 187 | 188 | MSIKLM also comes with an uninstallation script uninstall.sh which will remove the program file 189 | /usr/local/bin/msiklm as well as running ./autostart --disable, i.e. it disables the autostart. 190 | If you want to use it, simply run: 191 | 192 | ./uninstall.sh 193 | 194 | 195 | # Developer Information 196 | 197 | The source code is split into three files: 198 | - Main application (`main.c`) that converts the input 199 | - Small library that contains the main features (`msiklm.h` and `msiklm.c`). 200 | This provides a simple C API and hence allows an easy integration into different programs like maybe 201 | a small graphical user interface. 202 | -------------------------------------------------------------------------------- /src/msiklm.c: -------------------------------------------------------------------------------- 1 | /** 2 | * @file msiklm.c 3 | * 4 | * @brief source file that contains controller functions to configure the SteelSeries keyboard in MSI gaming notebooks 5 | */ 6 | 7 | #include "msiklm.h" 8 | #include 9 | #include 10 | #include 11 | 12 | int parse_color(const char* color_str, struct color* result) 13 | { 14 | int ret = -1; 15 | if (color_str != NULL && result != NULL) 16 | { 17 | switch (color_str[0]) 18 | { 19 | case 'b': 20 | if (strcmp(color_str, "blue") == 0) 21 | { 22 | result->profile = blue; 23 | result->red = 0; 24 | result->green = 0; 25 | result->blue = 255; 26 | ret = 0; 27 | } 28 | break; 29 | 30 | case 'g': 31 | if (strcmp(color_str, "green") == 0) 32 | { 33 | result->profile = green; 34 | result->red = 0; 35 | result->green = 255; 36 | result->blue = 0; 37 | ret = 0; 38 | } 39 | break; 40 | 41 | case 'n': 42 | if (strcmp(color_str, "none") == 0) 43 | { 44 | result->profile = none; 45 | result->red = 0; 46 | result->green = 0; 47 | result->blue = 0; 48 | ret = 0; 49 | } 50 | break; 51 | 52 | case 'o': 53 | if (strcmp(color_str, "orange") == 0) 54 | { 55 | result->profile = orange; 56 | result->red = 255; 57 | result->green = 100; 58 | result->blue = 0; 59 | ret = 0; 60 | } 61 | else if (strcmp(color_str, "off") == 0) 62 | { 63 | result->profile = none; 64 | result->red = 0; 65 | result->green = 0; 66 | result->blue = 0; 67 | ret = 0; 68 | } 69 | break; 70 | 71 | case 'p': 72 | if (strcmp(color_str, "purple") == 0) 73 | { 74 | result->profile = purple; 75 | result->red = 255; 76 | result->green = 0; 77 | result->blue = 255; 78 | ret = 0; 79 | } 80 | break; 81 | 82 | case 'r': 83 | if (strcmp(color_str, "red") == 0) 84 | { 85 | result->profile = red; 86 | result->red = 255; 87 | result->green = 0; 88 | result->blue = 0; 89 | ret = 0; 90 | } 91 | break; 92 | 93 | case 's': 94 | if (strcmp(color_str, "sky") == 0) 95 | { 96 | result->profile = sky; 97 | result->red = 0; 98 | result->green = 255; 99 | result->blue = 255; 100 | ret = 0; 101 | } 102 | break; 103 | 104 | case 'w': 105 | if (strcmp(color_str, "white") == 0) 106 | { 107 | result->profile = white; 108 | result->red = 255; 109 | result->green = 255; 110 | result->blue = 255; 111 | ret = 0; 112 | } 113 | break; 114 | 115 | case 'y': 116 | if (strcmp(color_str, "yellow") == 0) 117 | { 118 | result->profile = yellow; 119 | result->red = 255; 120 | result->green = 255; 121 | result->blue = 0; 122 | ret = 0; 123 | } 124 | break; 125 | 126 | case '[': //[red;green;blue] 127 | { 128 | result->profile = custom; 129 | 130 | size_t length = strlen(color_str); 131 | char* color_rgb = (char*)malloc(length * sizeof(char)); 132 | strcpy(color_rgb, &color_str[1]); //copy the string and skip the '['-sign 133 | color_rgb[length] = '\0'; 134 | 135 | char* saved_ptr = NULL; 136 | char* end_ptr = NULL; 137 | 138 | //try to parse the red value 139 | long val = strtol(strtok_r(color_rgb, ";", &saved_ptr), &end_ptr, 10); 140 | if (*end_ptr == '\0' && *saved_ptr != '\0' && val >= 0 && val <= 255) 141 | { 142 | result->red = (byte)val; 143 | 144 | //try to parse the green value 145 | val = strtol(strtok_r(NULL, ";", &saved_ptr), &end_ptr, 10); 146 | if (*end_ptr == '\0' && *saved_ptr != '\0' && val >= 0 && val <= 255) 147 | { 148 | result->green = (byte)val; 149 | 150 | //finally try to parse the blue value 151 | val = strtol(strtok_r(NULL, "]", &saved_ptr), &end_ptr, 10); 152 | if (*end_ptr == '\0' && *saved_ptr == '\0' && val >= 0 && val <= 255) 153 | { 154 | result->blue = (byte)val; 155 | ret = 0; 156 | } 157 | } 158 | } 159 | free(color_rgb); 160 | } 161 | break; 162 | 163 | case '0': //color in hex format 164 | if (strlen(color_str) == 8 && color_str[1] == 'x') 165 | { 166 | result->profile = custom; 167 | 168 | int red1 = parse_hex(color_str[2]); 169 | if (red1 >= 0) 170 | { 171 | int red2 = parse_hex(color_str[3]); 172 | if (red2 >= 0) 173 | { 174 | result->red = 16 * red1 + red2; 175 | int green1 = parse_hex(color_str[4]); 176 | if (green1 >= 0) 177 | { 178 | int green2 = parse_hex(color_str[5]); 179 | if (green2 >= 0) 180 | { 181 | result->green = 16 * green1 + green2; 182 | int blue1 = parse_hex(color_str[6]); 183 | if (blue1 >= 0) 184 | { 185 | int blue2 = parse_hex(color_str[7]); 186 | if (blue2 >= 0) 187 | { 188 | result->blue = 16 * blue1 + blue2; 189 | ret = 0; 190 | } 191 | } 192 | } 193 | } 194 | } 195 | } 196 | } 197 | break; 198 | 199 | case '#': //another hex format for color 200 | if (strlen(color_str) == 7) 201 | { 202 | result->profile = custom; 203 | 204 | int red1 = parse_hex(color_str[1]); 205 | if (red1 >= 0) 206 | { 207 | int red2 = parse_hex(color_str[2]); 208 | if (red2 >= 0) 209 | { 210 | result->red = 16 * red1 + red2; 211 | int green1 = parse_hex(color_str[3]); 212 | if (green1 >= 0) 213 | { 214 | int green2 = parse_hex(color_str[4]); 215 | if (green2 >= 0) 216 | { 217 | result->green = 16 * green1 + green2; 218 | int blue1 = parse_hex(color_str[5]); 219 | if (blue1 >= 0) 220 | { 221 | int blue2 = parse_hex(color_str[6]); 222 | if (blue2 >= 0) 223 | { 224 | result->blue = 16 * blue1 + blue2; 225 | ret = 0; 226 | } 227 | } 228 | } 229 | } 230 | } 231 | } 232 | } 233 | break; 234 | } 235 | } 236 | return ret; 237 | } 238 | 239 | enum brightness parse_brightness(const char* brightness_str) 240 | { 241 | enum brightness ret = -1; 242 | if (brightness_str != NULL) 243 | { 244 | switch (brightness_str[0]) 245 | { 246 | case 'h': 247 | if (strcmp(brightness_str, "high") == 0) 248 | ret = high; 249 | break; 250 | 251 | case 'm': 252 | if (strcmp(brightness_str, "medium") == 0) 253 | ret = medium; 254 | break; 255 | 256 | case 'l': 257 | if (strcmp(brightness_str, "low") == 0) 258 | ret = low; 259 | break; 260 | 261 | case 'o': 262 | if (strcmp(brightness_str, "off") == 0) 263 | ret = off; 264 | break; 265 | 266 | case 'r': 267 | if (strcmp(brightness_str, "rgb") == 0) 268 | ret = rgb; 269 | break; 270 | } 271 | } 272 | return ret; 273 | } 274 | 275 | enum mode parse_mode(const char* mode_str) 276 | { 277 | enum mode ret = -1; 278 | if (mode_str != NULL) 279 | { 280 | switch (mode_str[0]) 281 | { 282 | case 'n': 283 | if (strcmp(mode_str, "normal") == 0) 284 | ret = normal; 285 | break; 286 | 287 | case 'g': 288 | if (strcmp(mode_str, "gaming") == 0) 289 | ret = gaming; 290 | break; 291 | 292 | case 'b': 293 | if (strcmp(mode_str, "breathe") == 0) 294 | ret = breathe; 295 | break; 296 | 297 | case 'd': 298 | if (strcmp(mode_str, "demo") == 0) 299 | ret = demo; 300 | break; 301 | 302 | case 'w': 303 | if (strcmp(mode_str, "wave") == 0) 304 | ret = wave; 305 | break; 306 | } 307 | } 308 | return ret; 309 | } 310 | 311 | bool keyboard_found() 312 | { 313 | hid_device* dev = open_keyboard(); 314 | bool ret = dev != NULL; 315 | if (ret) 316 | hid_close(dev); 317 | return ret; 318 | } 319 | 320 | hid_device* open_keyboard() 321 | { 322 | hid_device* dev = NULL; 323 | if (hid_init() == 0) 324 | dev = hid_open(0x1770, 0xff00, 0); 325 | return dev; 326 | } 327 | 328 | int set_color(hid_device* dev, struct color color, enum region region, enum brightness brightness) 329 | { 330 | int ret = -1; 331 | if ((region == left || region == middle || region == right || region == logo || region == front_left || region == front_right || region == mouse) && //valid region 332 | (brightness == rgb || brightness == off || color.profile != custom)) //explicit brightness is only valid for predefined colors (i.e. rgb-selection mixed with brightness makes little sense) 333 | { 334 | byte buffer[8]; 335 | buffer[0] = 1; 336 | buffer[1] = 2; 337 | buffer[3] = (byte)region; 338 | buffer[7] = 236; //EOR (end of request) 339 | 340 | if (brightness == rgb) //full rgb selection -> rgb-command 341 | { 342 | buffer[2] = 64; //rgb 343 | buffer[4] = color.red; 344 | buffer[5] = color.green; 345 | buffer[6] = color.blue; 346 | } 347 | else //predefined color with explicit brightness -> set-command 348 | { 349 | buffer[2] = 66; //set 350 | buffer[4] = brightness != off ? (byte)color.profile : 0; 351 | buffer[5] = (byte)brightness; 352 | buffer[6] = 0; 353 | } 354 | 355 | ret = hid_send_feature_report(dev, buffer, 8); 356 | } 357 | return ret; 358 | } 359 | 360 | int set_mode(hid_device* dev, enum mode mode) 361 | { 362 | int ret = -1; 363 | if (mode == normal || mode == gaming || mode == breathe || mode == demo || mode == wave) //check for a valid mode 364 | { 365 | byte buffer[8]; 366 | buffer[0] = 1; 367 | buffer[1] = 2; 368 | buffer[2] = 65; //commit 369 | buffer[3] = (byte)mode; //set hardware mode 370 | buffer[4] = 0; 371 | buffer[5] = 0; 372 | buffer[6] = 0; 373 | buffer[7] = 236; //EOR (end of request) 374 | ret = hid_send_feature_report(dev, buffer, 8); 375 | } 376 | return ret; 377 | } 378 | 379 | int parse_hex(unsigned char hex) 380 | { 381 | int ret = -1; 382 | if (hex >= '0' && hex <= '9') ret = hex - '0'; 383 | else if (hex >= 'A' && hex <= 'F') ret = 10 + hex - 'A'; 384 | else if (hex >= 'a' && hex <= 'f') ret = 10 + hex - 'a'; 385 | return ret; 386 | } 387 | -------------------------------------------------------------------------------- /src/main.c: -------------------------------------------------------------------------------- 1 | /** 2 | * @file main.c 3 | * 4 | * @brief the main application 5 | */ 6 | 7 | #include 8 | #include 9 | #include 10 | #include "msiklm.h" 11 | 12 | //the following macros can be used for colored text output 13 | #ifndef _WIN32 14 | #define KDEFAULT "\033[0m" 15 | #define KNRM "\x1B[0m" 16 | #define KRED "\x1B[31m" 17 | #define KGRN "\x1B[32m" 18 | #define KYEL "\x1B[33m" 19 | #define KBLU "\x1B[34m" 20 | #define KMAG "\x1B[35m" 21 | #define KCYN "\x1B[36m" 22 | #define KWHT "\x1B[37m" 23 | #else 24 | #define KDEFAULT "" 25 | #define KNRM "" 26 | #define KRED "" 27 | #define KGRN "" 28 | #define KYEL "" 29 | #define KBLU "" 30 | #define KMAG "" 31 | #define KCYN "" 32 | #define KWHT "" 33 | #endif 34 | 35 | /** 36 | * @brief prints help information 37 | */ 38 | void show_help() 39 | { 40 | printf(KRED 41 | "MSIKLM - MSI Keyboard Light Manager\n" 42 | "###################################\n" 43 | KYEL 44 | "\n" 45 | "utility to configure the SteelSeries keyboard in MSI Gaming Notebooks - possible arguments:\n" 46 | "\n" 47 | KMAG 48 | "help\n" 49 | KDEFAULT 50 | " show this help\n" 51 | "\n" 52 | KMAG 53 | "test\n" 54 | KDEFAULT 55 | " test if a compatible SteelSeries MSI Gaming Notebook is detected\n" 56 | "\n" 57 | KMAG 58 | "list\n" 59 | KDEFAULT 60 | " list all found HID devices\n" 61 | "\n" 62 | KMAG 63 | " OR ,[,,,,,]\n" 64 | KDEFAULT 65 | " sets a color for the respective zone at full brightness;\n" 66 | " if multiple values are supplied, they have to be separated with commas without spaces,\n" 67 | " e.g. red or red,green,blue are valid while red,green, blue or red, green, blue are not\n" 68 | " it is valid to supply three times the same value, but the result will be the same as supplying it only once\n" 69 | " valid predefined colors are: none, off (equivalent to none), red, orange, yellow, green, sky, blue, purple, white\n" 70 | " additionally it is possible to supply a color in full RGB notation; in this case it has to be supplied either in the format\n" 71 | " [red;green;blue] where the brackets are required and 'red', 'green' and 'blue' are the respective color values (range 0 to 255)\n" 72 | " or in hex code (0x000000 to 0xFFFFFF) notations where the respective values have to be selected accordingly\n" 73 | " it is also supported to mix the predefined colors with explicit definitions\n" 74 | " please note that it might be necessary to put quotation marks around explicit color definitions,\n" 75 | " otherwise the argument might not be properly processed by the shell; cf. Readme.md for more detailed information\n" 76 | " remark: to disable the illumination, use off or none as global color\n" 77 | "\n" 78 | KMAG 79 | " \n" 80 | KDEFAULT 81 | " additionally to the color, also a brightness can be specified for all zones where a predefined color is used;\n" 82 | " thus, the respective brightness selection will be ignored for all zones where a custom rgb selection has been given\n" 83 | " so valid brightnesses are 'low', 'medium', 'high' and 'rgb' where 'rgb' is the default value\n" 84 | " important: as soon as a brightness has been set, a different command is used, so it might solve problems to explicitly define it\n" 85 | "\n" 86 | KMAG 87 | " \n" 88 | KDEFAULT 89 | " sets the respective zone's color(s) and activates the specified mode\n" 90 | " mode is one of the following effects: normal, gaming, breathe, demo, wave\n" 91 | "\n" 92 | KMAG 93 | " \n" 94 | KDEFAULT 95 | " simultaneously sets the respective zone's color(s) with a specified brightness and a mode\n" 96 | "\n" 97 | KMAG 98 | "\n" 99 | KDEFAULT 100 | " only set a mode and keep the colors unchanged\n" 101 | ); 102 | } 103 | 104 | /** 105 | * @brief this function is called whenever parsing of an argument failed in some way and prints a respective error message 106 | * @param value the string that could not be parsed (might be null) 107 | * @param expected_type string that informs about the expected input type (might be null) 108 | */ 109 | void on_parse_error(const char* value, const char* expected_type) 110 | { 111 | if (value == NULL) 112 | printf(KRED"Invalid arguments supplied; use 'msiklm help' to show a list of valid arguments\n"KDEFAULT); 113 | else if (expected_type == NULL) 114 | printf(KRED"Invalid argument '%s' - use 'msiklm help' to list an overview of valid commands\n"KDEFAULT, value); 115 | else 116 | printf(KRED"Invalid %s argument '%s' - use 'msiklm help' to list an overview of valid commands\n"KDEFAULT, expected_type, value); 117 | } 118 | 119 | /** 120 | * @brief similar to parse_brightness() but additionally checks if the brightness is valid for the current color selection 121 | * @param brightness_str the brightness value as a string 122 | * @param with_rgb explicit brightnesses other than 'rgb' are only valid if there is no explicit rgb-color defined 123 | * @returns the parsed brightness value, -1 if the string is not a valid brightness or -2 if its only invalid for the current color selection 124 | */ 125 | enum brightness parse_check_brightness(const char* brightness_str, bool with_rgb) 126 | { 127 | enum brightness br = parse_brightness(brightness_str); 128 | if ((int)br >= 0 && with_rgb && (br == high || br == medium || br == low)) 129 | { 130 | on_parse_error(brightness_str, "rgb-color brightness"); 131 | br = -2; 132 | } 133 | return br; 134 | } 135 | 136 | /** 137 | * @brief iterates through all found HID devices and prints some output about them 138 | */ 139 | void enumerate_hid() 140 | { 141 | struct hid_device_info* enumerate = hid_enumerate(0,0); 142 | 143 | if (enumerate != NULL) 144 | { 145 | struct hid_device_info* dev = enumerate; 146 | while (dev != NULL) 147 | { 148 | printf("Device: %S\n", dev->product_string); 149 | printf(" Device Vendor ID: %i\n", dev->vendor_id); 150 | printf(" Device Product ID: %i\n", dev->product_id); 151 | printf(" Device Serial Number: %S\n", dev->serial_number); 152 | printf(" Device Manufacturer: %S\n", dev->manufacturer_string); 153 | printf(" Device Path: %s\n", dev->path); 154 | printf(" Device Interface Number: %i\n", dev->interface_number); 155 | printf(" Device Release Number: %d\n", dev->release_number); 156 | printf("\n"); 157 | dev = dev->next; 158 | } 159 | hid_free_enumeration(enumerate); 160 | } 161 | else 162 | { 163 | printf("No HID device found!\n"); 164 | } 165 | } 166 | 167 | /** 168 | * @brief application's entry point 169 | * @param argc number of command line arguments 170 | * @param argv command line argument array; the first value is always the program's name 171 | * @return 0 if everything succeeded, -1 otherwise 172 | */ 173 | int main(int argc, char** argv) 174 | { 175 | //the color values (at most 7); num_regions tracks the actual number of parsed colors (i.e. regions to set) while with_rgb indicates if there is any rgb-color used 176 | struct color colors[7]; 177 | int num_regions = 0; 178 | bool with_rgb = false; 179 | int ret = argc > 1 ? hid_init() : -1; 180 | 181 | //if colors are supplied, they are always the first argument, so try to parse them 182 | if (ret == 0) 183 | { 184 | size_t length = strlen(argv[1]); 185 | char* color_arg = (char*)malloc((length+1) * sizeof(char)); 186 | if (color_arg != NULL) 187 | { 188 | strcpy(color_arg, argv[1]); 189 | color_arg[length] = '\0'; 190 | 191 | char* saved_ptr = NULL; 192 | const char* color_str = strtok_r(color_arg, ",", &saved_ptr); 193 | while (color_str != NULL && ret == 0) //parse into next color slot as long as a color is available for parsing (color_str != NULL) and previous parsing succeeded (ret == 0) 194 | { 195 | if (num_regions < 7 && 196 | !(ret = parse_color(color_str, &(colors[num_regions])))) 197 | { 198 | if (colors[num_regions].profile == custom) 199 | with_rgb = true; 200 | ++num_regions; 201 | color_str = strtok_r(NULL, ",", &saved_ptr); 202 | } 203 | else 204 | { 205 | ret = -1; 206 | } 207 | } 208 | free(color_arg); 209 | } 210 | else 211 | { 212 | ret = -1; 213 | } 214 | } 215 | 216 | //the brightness and the mode; initialize them according to the parsed command line arguments 217 | enum brightness br = ret == 0 ? rgb : -1; 218 | enum mode md = ret == 0 ? normal : -1; 219 | 220 | //it holds: if ret == 0, the num_regions color values are all valid (and will be set) or brightness and mode are -1 (colors will not be modified, only maybe the mode) 221 | 222 | switch (argc) 223 | { 224 | case 2: 225 | // only one command line argument; valid values are: 226 | // '' -> set the respective color(s) 227 | // '' -> set the respective mode 228 | // 'help' -> show the help 229 | // 'test' -> try to find a compatible SteelSeries MSI Gaming Notebook 230 | // 'list' -> list all found HID devices 231 | 232 | if (ret != 0) //nothing to do if colors are parsed successfully 233 | { 234 | md = parse_mode(argv[1]); 235 | if ((int)md >= 0) 236 | { 237 | ret = 0; 238 | } 239 | else //invalid mode: check for 'help', 'test' or 'list' 240 | { 241 | switch (argv[1][0]) 242 | { 243 | case 'h': 244 | if (strcmp(argv[1], "help") == 0) 245 | { 246 | show_help(); 247 | ret = 0; 248 | } 249 | break; 250 | 251 | case 't': 252 | if (strcmp(argv[1], "test") == 0) 253 | { 254 | if (keyboard_found()) 255 | printf(KMAG"Compatible keyboard found!\n"KDEFAULT); 256 | else 257 | printf(KMAG 258 | "No compatible keyboard found!\n" 259 | KDEFAULT 260 | "Check you're using sudo!\n"); 261 | ret = 0; 262 | } 263 | break; 264 | 265 | case 'l': 266 | if (strcmp(argv[1], "list") == 0) 267 | { 268 | enumerate_hid(); 269 | ret = 0; 270 | } 271 | break; 272 | } 273 | 274 | if (ret != 0) 275 | on_parse_error(argv[1], NULL); 276 | } 277 | } 278 | break; 279 | 280 | case 3: 281 | // two command line arguments; valid inputs are: 282 | // ' ' -> set the respective color(s) and brightness 283 | // ' ' -> set the respective color(s) and mode 284 | 285 | if (ret == 0) 286 | { 287 | enum brightness b = parse_check_brightness(argv[2], with_rgb); 288 | if ((int)b >= 0) 289 | { 290 | br = b; 291 | } 292 | else if ((int)b >= -1) 293 | { 294 | enum mode m = parse_mode(argv[2]); 295 | if ((int)m >= 0) 296 | { 297 | md = m; 298 | } 299 | else 300 | { 301 | on_parse_error(argv[2], "brightness / mode"); 302 | ret = -1; 303 | } 304 | } 305 | else 306 | { 307 | ret = -1; 308 | } 309 | } 310 | else 311 | { 312 | on_parse_error(argv[1], "color"); 313 | ret = -1; 314 | } 315 | break; 316 | 317 | case 4: 318 | // three command line arguments; valid input is only 319 | 320 | if (ret == 0) 321 | { 322 | br = parse_check_brightness(argv[2], with_rgb); 323 | if ((int)br >= 0) 324 | { 325 | md = parse_mode(argv[3]); 326 | if ((int)md < 0) 327 | { 328 | on_parse_error(argv[3], "mode"); 329 | ret = -1; 330 | } 331 | } 332 | else 333 | { 334 | if ((int)br >= -1) 335 | on_parse_error(argv[2], "brightness"); 336 | ret = -1; 337 | } 338 | } 339 | else 340 | { 341 | on_parse_error(argv[1], "color"); 342 | ret = -1; 343 | } 344 | break; 345 | 346 | default: 347 | // too many or no command line arguments 348 | on_parse_error(NULL, NULL); 349 | break; 350 | } 351 | 352 | if (ret == 0 && (int)md >= 0) 353 | { 354 | hid_device* dev = open_keyboard(); 355 | 356 | if (dev != NULL) 357 | { 358 | if (num_regions == 1 && md != gaming) //special case: one color will be used for the first three regions (gaming mode requires only one region) 359 | { 360 | colors[2] = colors[1] = colors[0]; 361 | num_regions = 3; 362 | } 363 | 364 | for (int i=0; i 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------