├── .emacs.d ├── .gitignore ├── config.org └── init.el ├── LICENSE.org ├── README.org ├── config ├── c-and-cpp.org ├── evil.org ├── python.org ├── rust.org └── undo-tree.org └── templates.org /.emacs.d/.gitignore: -------------------------------------------------------------------------------- 1 | elpa/ 2 | var/ 3 | -------------------------------------------------------------------------------- /.emacs.d/config.org: -------------------------------------------------------------------------------- 1 | #+TITLE: TPHmacs 2 | #+AUTHOR: TPH Gang 3 | #+STARTUP: overview 4 | 5 | * Preface 6 | 7 | Hey! So in your =init.el= you just have one line! The line 8 | 9 | #+begin_src 10 | (org-babel-load-file (concat user-emacs-directory "config.org")) 11 | #+end_src 12 | 13 | is very simple. To start with, =(concat user-emacs-directory "config.org")= 14 | concatenates "config.org" to your emacs directory. Although the [[file:~/github/emacs/README.org][README.org]] stated to 15 | copy and paste this into your =.emacs.d=, your =.emacs.d= doesn't have to be where your 16 | configuration is stored. There is a neat project called [[https://github.com/plexus/chemacs][chemacs]] which lets you run 17 | multiple emacs configurations once you set it up. This can be helpful when you're 18 | testing out new features or want to try other configurations. 19 | 20 | So, assuming you're using =.emacs.d=, we now have the string =~/.emacs.d/config.org=. 21 | =org-babel-load-file= does something particularly cool: it tangles emacs-lisp source 22 | blocks =~/.emacs.d/config.org=. Referring to documentations: 23 | 24 | #+begin_quote 25 | (org-babel-load-file FILE &optional COMPILE) 26 | 27 | Load Emacs Lisp source code blocks in the Org FILE. 28 | This function exports the source code using ‘org-babel-tangle’ 29 | and then loads the resulting file using ‘load-file’. With 30 | optional prefix argument COMPILE, the tangled Emacs Lisp file is 31 | byte-compiled before it is loaded. 32 | #+end_quote 33 | 34 | To begin with, the definition mentions =load-file= which does what it sounds like: it 35 | loads a file. If we had written the emacs configuration into a file like =config.el=, 36 | we could have called =(load-file (concat user-emacs-directory "config.org")=. Or, we 37 | could have left the entire configuration in =init.el= at that point... The benefit of 38 | using an org file is that we get a /literate/ configuration. ~babel~ is an immensely 39 | powerful tool which is heavily integrated into org (which we'll discuss later). 40 | 41 | Backtracking to the idea of 'emacs-lisp source blocks' being 'tangled', essentially 42 | any blocks in the org file starting with =#+begin_src emacs-lisp= to =#+end_src= will 43 | be read into the compiled el file which gets loaded. Without specifying anything, 44 | emacs will automagically try to use the name of the org file for the el file 45 | (config.org will compile to config.el). This can be changed by modifying the file's 46 | properties, which is as simple as placing =#+property: header-args :tangle init.el= 47 | on top of the file. The snippet in the previous line tangles the file to =init.el=. 48 | 49 | * Pre-Configuration 50 | 51 | This code should be executed first. It's general, but will make the rest of the configuration nicer since it's somewhat 'meta'. 52 | 53 | ** Initialization 54 | 55 | Add lexical binding support 56 | 57 | #+begin_src emacs-lisp 58 | ;; -*- lexical-binding: t -*- 59 | #+end_src 60 | 61 | Older versions of Emacs and those on Windows may have problems making secure remote connections due to [[https://debbugs.gnu.org/cgi/bugreport.cgi?bug=34341][this issue]]. 62 | #+BEGIN_SRC emacs-lisp 63 | (setq gnutls-algorithm-priority "NORMAL:-VERS-TLS1.3") 64 | #+END_SRC 65 | 66 | *** Garbage Collection 67 | 68 | We don't need garbage collection during start up. 69 | 70 | #+begin_src emacs-lisp 71 | (eval-and-compile 72 | (defun srs|revert-gc () 73 | ;; reset values 74 | (setq gc-cons-threshold 16777216 75 | gc-cons-percentage 0.1 76 | file-name-handler-alist (append last-file-name-handler-alist 77 | file-name-handler-alist)) 78 | ;; delete any duplicate values 79 | (cl-delete-duplicates file-name-handler-alist :test 'equal) 80 | ;; get rid of temporarily variables 81 | (makunbound 'last-file-name-handler-alist)) 82 | 83 | ;; set everything to efficient limits and save values 84 | (setq gc-cons-threshold most-positive-fixnum 85 | gc-cons-percentage 0.6 86 | last-file-name-handler-alist file-name-handler-alist 87 | file-name-handler-alist nil) 88 | 89 | (add-hook 'after-init-hook 'srs|revert-gc)) 90 | #+end_src 91 | 92 | ** Package Archives 93 | 94 | All of the third-party packages we’re going to reference are available through [[https://melpa.org/][MELPA]]. This is your one stop shop for finding and installing Emacs addons. Run =M-x list-packages= to bring up an interactive searchable list. When the point is over a package line, hit =i= to mark the package for installation, then =x= to install all marked packages. If packages have updates, mark them all with `U`. 95 | 96 | #+begin_src emacs-lisp 97 | (require 'package) 98 | (setq package-enable-at-startup nil) 99 | #+end_src 100 | 101 | Set up all the archive sources to pull from packages from. 102 | 103 | #+begin_src emacs-lisp 104 | (setq package-archives '(("melpa" . "http://melpa.milkbox.net/packages/") 105 | ("gnu" . "http://elpa.gnu.org/packages/") 106 | ("org" . "https://orgmode.org/elpa/"))) 107 | 108 | (package-initialize) 109 | #+end_src 110 | 111 | ** Package Installers 112 | 113 | The primary tool we use to configure our Emacs packages, aptly called [[https://jwiegley.github.io/use-package/][use-package]], automatically downloads packages from a package source, speeds up startup by deferring package loading until necessary, and helps keep your configuration tidy by providing a place to combine package-specific settings and other mode and action hooks. 114 | 115 | #+begin_src emacs-lisp 116 | (unless (package-installed-p 'use-package) 117 | (package-refresh-contents) 118 | (package-install 'use-package)) 119 | 120 | (eval-when-compile 121 | (require 'use-package)) 122 | 123 | ;; Yes, it's a bit meta... 124 | (use-package use-package 125 | :config 126 | (setq-default use-package-always-defer t 127 | use-package-always-demand nil 128 | use-package-always-ensure t 129 | use-package-verbose t)) 130 | 131 | (setq-default byte-compile-warnings nil) 132 | #+end_src 133 | 134 | * Projects 135 | 136 | - https://github.com/bbatsov/projectile 137 | - https://www.projectile.mx/en/latest/ 138 | 139 | Projectile gives Emacs project management features, such as navigating files, finding occurences of a string, running build commands and more. 140 | It detects project folders through version control (git, svn, ...) and you can optionally give a default project folder path within the config. 141 | 142 | #+begin_src emacs-lisp 143 | (use-package projectile 144 | ;; Getting complaints about undefined variables when these are placed in 145 | ;; `:custom`. 146 | :config 147 | ;; Useful for any CMake-based project, and using `ccls` with C/C++ 148 | (setq projectile-project-root-files-top-down-recurring 149 | (append 150 | '("compile_commands.json" ".ccls") 151 | projectile-project-root-files-top-down-recurring)) 152 | (setq projectile-globally-ignored-directories 153 | (append 154 | '("build" "CMakeFiles" ".ccls-cache") 155 | projectile-globally-ignored-directories)) 156 | (setq projectile-globally-ignored-files 157 | (append 158 | '("cmake_install.cmake") 159 | projectile-globally-ignored-files)) 160 | :custom 161 | (projectile-project-search-path '("~/Projects/")) 162 | (projectile-enable-caching t) 163 | (projectile-require-project-root t) 164 | (projectile-sort-order 'access-time) 165 | :init 166 | (projectile-mode)) 167 | #+end_src 168 | 169 | * Magit 170 | 171 | [[https://github.com/magit/magit][Magit]] is a Git interface, just like you have in many IDEs and text editors, but combining that with all the power of using Git from the command line. 172 | 173 | #+begin_src emacs-lisp 174 | (use-package magit) 175 | #+end_src 176 | 177 | * Key bindings 178 | 179 | [[https://github.com/justbur/emacs-which-key][Which-key]] is a package that displays what bindings are available when you start pressing a key. It is incredibly useful, especially when you are new to Emacs or when you are trying a new package. 180 | 181 | #+BEGIN_SRC emacs-lisp 182 | (use-package which-key 183 | :init 184 | (which-key-mode)) 185 | #+END_SRC 186 | 187 | * Linters 188 | 189 | The two main frameworks that allow Emacs to interface with external linters are 190 | - [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Flymake.html][flymake]] 191 | - [[https://www.flycheck.org/en/latest/][flycheck]] 192 | A detailed comparison is at https://www.flycheck.org/en/latest/user/flycheck-versus-flymake.html. We choose to use flycheck due to the sheer number of extensions written for it; pick your favorite language linter, and there’s probably a flycheck extension for it. Note that [[https://www.flycheck.org/en/latest/user/installation.html#windows-support][Windows isn't supported]]. 193 | 194 | #+BEGIN_SRC emacs-lisp 195 | (use-package flycheck 196 | :hook (after-init . global-flycheck-mode) 197 | :custom 198 | (flycheck-check-syntax-automatically '(save mode-enabled))) 199 | #+END_SRC 200 | 201 | ** Documentation 202 | 203 | When the point is overlapping with a function call, eldoc shows the function arguments in the echo area. 204 | 205 | #+BEGIN_SRC emacs-lisp 206 | (use-package eldoc 207 | :hook (after-init . global-eldoc-mode)) 208 | #+END_SRC 209 | 210 | * Language and debug servers 211 | 212 | [[https://microsoft.github.io/language-server-protocol][LSP]] is a protocol used to implement IDE-like features in an editor-agnostic manner. This package will give us a uniform way to add features such as semantic highlighting, auto-completion, jump-to-definition, and so on. 213 | 214 | #+BEGIN_SRC emacs-lisp 215 | (use-package lsp-mode 216 | :commands lsp 217 | :custom 218 | (lsp-auto-guess-root t) 219 | (lsp-log-io t) 220 | (lsp-prefer-flymake nil)) 221 | #+END_SRC 222 | 223 | This package enhances the user interface, providing pop-up windows with documentation and visual indicators. 224 | 225 | #+BEGIN_SRC emacs-lisp 226 | (use-package lsp-ui 227 | :hook (lsp-mode . lsp-ui-mode) 228 | :custom 229 | (lsp-ui-doc-delay 3.0) 230 | (lsp-ui-doc-include-signature t) 231 | (lsp-ui-flycheck-enable t) 232 | (lsp-ui-peek-always-show t)) 233 | #+END_SRC 234 | 235 | Analogous to LSP is the [[https://microsoft.github.io/debug-adapter-protocol/][debug adapter protocol]]. We use [[https://github.com/emacs-lsp/lsp-treemacs][treemacs]] for IDE-like display of errors. 236 | 237 | #+BEGIN_SRC emacs-lisp 238 | (use-package dap-mode 239 | :after lsp-mode 240 | :config 241 | (dap-mode t) 242 | (dap-ui-mode t)) 243 | 244 | (use-package treemacs 245 | :bind (:map global-map 246 | ("C-x t t" . treemacs) 247 | ("C-x t 1" . treemacs-select-window)) 248 | :custom 249 | (treemacs-resize-icons 15)) 250 | 251 | (use-package lsp-treemacs 252 | :init 253 | (lsp-treemacs-sync-mode 1)) 254 | #+END_SRC 255 | 256 | * Code completion 257 | 258 | Company is the primary package that is used for code completion, it follows a frontend/backend system. The package =company= is the frontend, it will query a certain backend based on what code you are editing, such as one provided by an active language server. 259 | 260 | #+BEGIN_SRC emacs-lisp 261 | (use-package company 262 | :hook (after-init . global-company-mode) 263 | :custom 264 | (company-tooltip-align-annotations t)) 265 | 266 | (use-package company-lsp 267 | :after (company lsp-mode) 268 | :custom 269 | (company-lsp-cache-candidates t)) 270 | #+END_SRC 271 | 272 | * Languages 273 | 274 | ** HTML / CSS / HTML Templates 275 | 276 | - [[https://docs.emmet.io/cheatsheet-a5.pdf][Emmet cheatsheet]] 277 | - [[https://www.youtube.com/watch?v=V8vizNQKtx0][Learn Emmet in 15 Minutes (YouTube)]] 278 | 279 | #+BEGIN_SRC emacs-lisp 280 | (use-package emmet-mode 281 | :hook ((css-mode php-mode sgml-mode rjsx-mode web-mode) . emmet-mode)) 282 | #+END_SRC 283 | 284 | ** JavaScript / TypeScript 285 | 286 | These two are probably the hardest configuration to get properly solely because of "standards". 287 | 288 | #+BEGIN_SRC emacs-lisp 289 | (use-package typescript-mode 290 | :hook 291 | (typescript-mode . lsp) 292 | :mode (("\\.ts\\'" . typescript-mode) 293 | ("\\.tsx\\'" . typescript-mode))) 294 | #+END_SRC 295 | 296 | Use Node modules if present. Especially helpful for versions of tools and for stuff like prettier. 297 | 298 | #+BEGIN_SRC emacs-lisp 299 | (use-package add-node-modules-path 300 | :hook ((web-mode rjsx-mode). add-node-modules-path)) 301 | #+END_SRC 302 | 303 | Actually add prettier (which will read from =.prettierrc= if it exists now). Note you’ll have to install it using =npm install -g prettier=. 304 | 305 | #+BEGIN_SRC emacs-lisp 306 | (use-package prettier-js 307 | :hook ((js-mode typescript-mode rjsx-mode) . prettier-js-mode) 308 | :custom 309 | ;; These checks are automatically handled by prettier. 310 | (js2-missing-semi-one-line-override t) 311 | (js2-strict-missing-semi-warning nil)) 312 | #+END_SRC 313 | 314 | [[https://github.com/ananthakumaran/tide][TypeScript Interactive Development Environment for Emacs]] 315 | 316 | #+BEGIN_SRC emacs-lisp 317 | (use-package tide 318 | :after 319 | (typescript-mode company flycheck) 320 | :hook 321 | ((typescript-mode . tide-setup) 322 | (typescript-mode . tide-hl-identifier-mode) 323 | (before-save . tide-format-before-save)) 324 | :config 325 | (flycheck-add-next-checker 'typescript-tide 'javascript-eslint) 326 | (flycheck-add-next-checker 'tsx-tide 'javascript-eslint)) 327 | #+END_SRC 328 | 329 | Modern React, note it’s generally a bad idea to bind this to ts or tsx since TypeScript uses =:= for types, which rjsx doesn’t seem to interpret well (it would be very nice if this was fixed!): 330 | 331 | #+BEGIN_SRC emacs-lisp 332 | (use-package rjsx-mode 333 | :hook 334 | (rjsx-mode . lsp) 335 | :mode 336 | (("\\.js\\'" . rjsx-mode) 337 | ("\\.jsx\\'" . rjsx-mode) 338 | ("\\.json\\'" . js-mode)) 339 | :magic ("/\\*\\* @jsx React\\.DOM \\*/" "^import React") 340 | :init 341 | (setq-default rjsx-basic-offset 2) 342 | (setq-default rjsx-global-externs '("module" "require" "assert" "setTimeout" "clearTimeout" "setInterval" "clearInterval" "location" "__dirname" "console" "JSON"))) 343 | 344 | (use-package react-snippets 345 | :after yasnippet) 346 | #+END_SRC 347 | 348 | For vue specifics as well: 349 | 350 | #+BEGIN_SRC emacs-lisp 351 | (use-package vue-html-mode) 352 | 353 | (use-package vue-mode 354 | :mode 355 | (("\\.vue\\'" . vue-mode))) 356 | #+END_SRC 357 | 358 | ** Java 359 | 360 | Java is a built-in mode, but its LSP and DAP interfaces are included separately from the main =lsp-mode= and =dap-mode=. 361 | 362 | #+BEGIN_SRC emacs-lisp 363 | (use-package lsp-java 364 | :hook 365 | ((java-mode . lsp) 366 | (java-mode . (lambda () (require 'dap-java))))) 367 | #+END_SRC 368 | 369 | ** Python 370 | 371 | Unfortunately the Python package situation is a little confusing. There are a few older separate packages that provide a Python major mode, but we prefer the built-in one and avoid downloading a third-party one by not ensuring it. This allows us to have =use-package= configure Python mode without downloading anything. 372 | 373 | #+BEGIN_SRC emacs-lisp 374 | (use-package python 375 | :ensure nil 376 | :hook (python-mode . lsp) 377 | :custom 378 | (python-indent-guess-indent-offset-verbose nil) 379 | (python-fill-docstring-style 'pep-257-nn)) 380 | #+END_SRC 381 | 382 | To use a language server with Python, there are two options: 383 | - =pyls= from [[https://github.com/palantir/python-language-server][Palantir]]: =pip install python-language-server=, and =lsp-mode= will automatically pick it up 384 | - =mspyls= from [[https://github.com/emacs-lsp/lsp-python-ms][Microsoft]]: see [[file:../config/python.org][here]]. 385 | 386 | ** C / C++ 387 | 388 | These are available as core modes, no install required. Defaults are good but things such as brace and comment style are configurable. 389 | 390 | #+BEGIN_SRC emacs-lisp 391 | (setq c-basic-offset 4) 392 | (setq c-default-style 393 | '((java-mode . "java") 394 | (awk-mode . "awk") 395 | ;; default is "gnu" 396 | (other . "k&r"))) 397 | (setq c-doc-comment-style 398 | '((c-mode . javadoc) 399 | (java-mode . javadoc) 400 | (pike-mode . autodoc))) 401 | 402 | (use-package c-mode 403 | :ensure nil 404 | :hook (c-mode . lsp)) 405 | 406 | (use-package c++-mode 407 | :ensure nil 408 | :hook (c++-mode . lsp)) 409 | #+END_SRC 410 | 411 | CMake is a common enough build tool that =cmake-mode= is a necessity. 412 | 413 | #+BEGIN_SRC emacs-lisp 414 | (use-package cmake-mode 415 | :mode 416 | (("CMakeLists\\.txt\\'" . cmake-mode) 417 | ("CMakeCache\\.txt\\'" . cmake-mode) 418 | ("\\.cmake\\'" . cmake-mode)) 419 | :custom 420 | (cmake-tab-width 4)) 421 | #+END_SRC 422 | 423 | The language server interface that automatically comes with =lsp-mode= is for [[https://clang.llvm.org/extra/clangd/Installation.html][clangd]]. It works well for projects that are millions of lines in size and requires no configuration other than hooks. [[https://github.com/MaskRay/ccls][ccls]] is also available, which supports more language server features than =clangd= like overlays and semantic highlighting (see =config/c-and-cpp.org=), see [[file:../config/c-and-cpp.org][here]]. 424 | 425 | Both LSP implementations benefit from having =compile_commands.json= in the Projectile-discovered project root, which is created by passing =-DCMAKE_EXPORT_COMPILE_COMMANDS=1= to =cmake=. 426 | 427 | ** Rust 428 | 429 | There are two available modes: 430 | - [[https://github.com/rust-lang/rust-mode][rust-mode]] 431 | - [[https://github.com/brotzeit/rustic][rustic]] 432 | 433 | Of these, rust-mode is minimal, with just syntax highlighting, hooks to rustfmt for formatting buffers, hooks to =cargo build/run/test/clippy=, and some automatic integration with ={lsp,eglot}-mode= with using =rls= as the backend (=rustup component add rls=). Rustic is more full-featured, with all the features of rust-mode available, plus better cargo command naming and output, rustfix integration, and automatic flymake or flycheck integration with clippy. Using [[https://github.com/rust-analyzer/rust-analyzer/][rust-analyzer]] as the language server backend is also possible. 434 | 435 | For example, here is how to run `cargo test` in each mode: 436 | - =rust-mode=: =M-x rust-test= 437 | - =rustic=: =M-x rustic-cargo-test= 438 | 439 | A sample =rustic= setup is 440 | 441 | #+BEGIN_SRC emacs-lisp 442 | (use-package rustic 443 | :custom 444 | (rustic-format-on-save t) 445 | (rustic-indent-method-chain t) 446 | ;; The default is 'rls 447 | (rustic-lsp-server 'rust-analyzer)) 448 | #+END_SRC 449 | 450 | For code completion, there is also the possibility to use racer; see [[file:../config/rust.org][here]]. 451 | 452 | ** Clojure 453 | 454 | =clojure-mode= brings us basic functionalities like syntax highlighting, formatting and refactoring. 455 | 456 | #+BEGIN_SRC emacs-lisp 457 | (use-package clojure-mode) 458 | #+END_SRC 459 | 460 | We want more advanced features, which we will get through [[https://cider.mx/][CIDER]], a minor mode that adds functionalities to Emacs for editing and developing Clojure applications. CIDER is a REPL-based environment for Clojure, adding code completion, debugging, testing, documentation lookup, project configuration and more. It is a huge package, and you'll want to read the documentations and experiment on your own. 461 | 462 | When it is installed, you can go to your Clojure buffer and run the command =M-x cider-jack-in= to start a REPL and be able to use CIDER’s features. 463 | 464 | #+BEGIN_SRC emacs-lisp 465 | (use-package cider 466 | :custom 467 | (cider-print-fn 'fipp) 468 | (cider-repl-pop-to-buffer-on-connect nil) 469 | (cider-repl-display-in-current-window nil) 470 | ;; enable if you want help displayed at the top of the CIDER nREPL 471 | (cider-repl-display-help-banner nil) 472 | ;; disable if it makes emacs slow 473 | (cider-font-lock-dynamically t)) 474 | #+END_SRC 475 | -------------------------------------------------------------------------------- /.emacs.d/init.el: -------------------------------------------------------------------------------- 1 | (org-babel-load-file (concat user-emacs-directory "config.org")) 2 | -------------------------------------------------------------------------------- /LICENSE.org: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 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 | 635 | Copyright (C) 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 | Copyright (C) 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 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | #+TITLE: README.org 2 | #+AUTHOR: TPH Gang 3 | #+STARTUP: overview 4 | 5 | * TPHmacs 6 | 7 | The Emacs brigade presents =TPHmacs=, The Programmers hangout's own little 8 | configuration for curious individuals. 9 | 10 | It will include the bare minimum in order to spark some sort of curiosity of how the 11 | ecosystem around Emacs works and maybe get you started on your own configuration with 12 | this as a starting point. 13 | 14 | Now, there are many different kinds of users and as a result, there is no one 15 | standard to follow in terms of configuration. You should use what fits your needs and 16 | wants the best. Ergo, we've decided to not give you a configuration! 17 | 18 | Instead, we provide the bare basics in =.emacs.d=. Next, we give sample, literate, 19 | configurations for various packages we use and found helpful. This is so you can 20 | check them out and learn from them. 21 | 22 | * Installation 23 | Just insert the folder content into ~.emacs.d~ and you are good to go. 24 | 25 | Note: it may be worth looking into [[https://www.gnu.org/software/stow/manual/stow.html][GNU stow]]. 26 | 27 | * Learn more 28 | if you are new to Emacs, be sure to go through the tutorial in order 29 | to learn the absolute basics in order to navigate and use Emacs. 30 | 31 | You can get there by typing ~C-h t~ which is ~Ctrl-h and then t~. 32 | 33 | And if you have gone through the tutorial and wants to know more, then 34 | [[https://www.emacswiki.org/][The Emacs Wiki]] should hold a lot of answers to your every need. 35 | -------------------------------------------------------------------------------- /config/c-and-cpp.org: -------------------------------------------------------------------------------- 1 | * Additional C / C++ components 2 | 3 | If you want to use [[https://github.com/MaskRay/ccls][ccls]], which supports more language server features than clangd like overlays and semantic highlighting, 4 | 5 | #+BEGIN_SRC emacs-lisp 6 | (use-package ccls 7 | :after lsp-mode 8 | :hook ((c-mode c++-mode) . (lambda () 9 | (require 'ccls) 10 | (lsp)))) 11 | #+END_SRC 12 | 13 | If you have trouble with installing ccls from your package manager, you might need to compile it from source and point =ccls-executable= to it. 14 | -------------------------------------------------------------------------------- /config/evil.org: -------------------------------------------------------------------------------- 1 | * Evil 2 | 3 | ** What is evil? 4 | 5 | *Evil* is an *e* xtensible *v* i *l* ayer for Emacs. 6 | 7 | ** Evil Prerequisites 8 | 9 | The extensible vi layer emulates the main features of Vim and adds 10 | them onto Emacs. This is something which is essential for any former 11 | Vim user and works right out of the box without any specific 12 | configuration additions, however evil depends on [[file:undo-tree.org][undo-tree]]. 13 | 14 | ** Evil Configuration 15 | 16 | #+begin_src emacs-lisp 17 | (use-package evil 18 | :after undo-tree 19 | :ensure t 20 | :config 21 | (evil-mode 1)) 22 | 23 | ; evil escape 24 | (use-package evil-escape) 25 | (evil-escape-mode t) 26 | 27 | (setq-default evil-escape-key-sequence "fd") 28 | (setq-default evil-escape-delay 0.2) 29 | #+end_src 30 | -------------------------------------------------------------------------------- /config/python.org: -------------------------------------------------------------------------------- 1 | * Additional Python components 2 | 3 | If you want to use the Microsoft Python language server, it's in a separate LSP package that automatically downloads the language server itself: 4 | 5 | #+BEGIN_SRC emacs-lisp 6 | (use-package lsp-python-ms 7 | :after lsp-mode 8 | :hook (python-mode . (lambda () 9 | (require 'lsp-python-ms) 10 | (lsp)))) 11 | #+END_SRC 12 | -------------------------------------------------------------------------------- /config/rust.org: -------------------------------------------------------------------------------- 1 | * Additional Rust components 2 | 3 | For code completion, there is also the possibility to use racer through https://github.com/racer-rust/emacs-racer, however it requires nightly Rust; rls and rust-analyzer work on the stable channel. It also requires some functionality that is in =rust-mode= but not =rustic=. Here is a translation of the instructions from their README: 4 | #+BEGIN_SRC emacs-lisp 5 | (use-package rust-mode 6 | :init 7 | (use-package racer 8 | :hook ((rust-mode . racer-mode) 9 | (racer-mode . eldoc-mode) 10 | (racer-mode . company-mode)) 11 | :bind (:map rust-mode-map 12 | ("TAB" . company-indent-or-complete)))) 13 | #+END_SRC 14 | -------------------------------------------------------------------------------- /config/undo-tree.org: -------------------------------------------------------------------------------- 1 | * Undo Tree 2 | 3 | ** What is undo tree? 4 | 5 | ** Undo Tree Prerequisites 6 | 7 | ** Undo Tree Configuration 8 | 9 | #+begin_src emacs-lisp 10 | (use-package undo-tree) 11 | #+end_src 12 | -------------------------------------------------------------------------------- /templates.org: -------------------------------------------------------------------------------- 1 | * Template Package 2 | 3 | ** What is Template Package? 4 | 5 | ** Template Package Prerequisites 6 | 7 | ** Template Package Configuration 8 | 9 | #+begin_src emacs-lisp 10 | #+end_src 11 | --------------------------------------------------------------------------------