├── screenshot.png ├── .gitignore ├── templates.go ├── config.go ├── README.md ├── cheat.go └── LICENSE /screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dufferzafar/cheat/HEAD/screenshot.png -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Built command 2 | cheat 3 | 4 | # These cheatsheets were downloaded from 5 | # https://github.com/chrisallenlane/cheat/tree/master/cheat/cheatsheets 6 | 7 | cheatsheets/ 8 | 9 | ################################################# Standard Go .gitignore 10 | 11 | # Compiled Object files, Static and Dynamic libs (Shared Objects) 12 | *.o 13 | *.a 14 | *.so 15 | 16 | # Folders 17 | _obj 18 | _test 19 | 20 | # Architecture specific extensions/prefixes 21 | *.[568vq] 22 | [568vq].out 23 | 24 | *.cgo1.go 25 | *.cgo2.c 26 | _cgo_defun.c 27 | _cgo_gotypes.go 28 | _cgo_export.* 29 | 30 | _testmain.go 31 | 32 | *.exe 33 | *.test 34 | -------------------------------------------------------------------------------- /templates.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | // These templates help modify the output presented by the cli package. 4 | var AppHelpTemplate = `{{.Name}} - {{.Usage}} 5 | 6 | Version: {{.Version}} 7 | 8 | Usage: 9 | {{.Name}} [cheatsheet] [] 10 | 11 | 12 | Commands: 13 | {{range .Commands}}{{.Name}}{{with .ShortName}}, {{.}}{{end}}{{ "\t" }}{{.Usage}} 14 | {{end}} 15 | 16 | Global Options: 17 | {{range .Flags}}{{.}} 18 | {{end}} 19 | 20 | Examples: 21 | {{.Name}} show git Shows git cheatsheet 22 | {{.Name}} show git -c 12 Copy the 12th git cheat 23 | 24 | {{.Name}} edit at Edit cheatsheet named at 25 | ` 26 | -------------------------------------------------------------------------------- /config.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "encoding/json" 5 | "io/ioutil" 6 | "os" 7 | "os/user" 8 | "path/filepath" 9 | "strings" 10 | ) 11 | 12 | type JSONData struct { 13 | Highlight bool `json:"highlight"` 14 | Linewrap int `json:"linewrap"` 15 | Editor string `json:"editor"` 16 | Cheatdirs []string `json:"cheatdirs"` 17 | } 18 | 19 | var defaults = `{ 20 | "highlight": true, 21 | "linewrap": 79, 22 | "cheatdirs": [ 23 | "~/.cheatsheets" 24 | ], 25 | "editor": "vim" 26 | }` 27 | 28 | func (q *JSONData) ReadConfig() error { 29 | usr, _ := user.Current() 30 | rcfile := filepath.Join(usr.HomeDir, ".cheatrc") 31 | 32 | settings := []byte(defaults) 33 | if _, err := os.Stat(rcfile); os.IsNotExist(err) { 34 | ioutil.WriteFile(rcfile, []byte(defaults), 0777) 35 | } else { 36 | settings, _ = ioutil.ReadFile(rcfile) 37 | } 38 | 39 | //Umarshalling JSON into struct 40 | var data = &q 41 | err := json.Unmarshal(settings, data) 42 | if err != nil { 43 | return err 44 | } 45 | for i, dir := range q.Cheatdirs { 46 | if strings.HasPrefix(dir, "~/") { 47 | q.Cheatdirs[i] = filepath.Join(usr.HomeDir, dir[2:]) 48 | } 49 | } 50 | return nil 51 | } 52 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # cheat 2 | 3 | Reimplementation of [Chris Lane's cheatsheet](https://github.com/chrisallenlane/cheat) script in [Go](http://golang.org/). 4 | 5 | I'm mostly doing this as a means of learning Go as it seemed like a nice first project to start with. 6 | 7 | ![Screenshot](screenshot.png) 8 | 9 | # Setup 10 | 11 | Install: `go get github.com/dufferzafar/cheat` 12 | 13 | Fetch cheatsheets: `cheat fetch` 14 | 15 | Test: `cheat show git` 16 | 17 | # Usage 18 | 19 | `~/.cheatrc` - A JSON based config file which stores basic configuration. 20 | 21 | `cheat show git` - Show the git cheatsheet 22 | 23 | `cheat edit git` - Edit the git sheet. A new one will be created if it doesn't already exist. 24 | 25 | `cheat show git --copy 12` - Copy the 12th cheat from the sheet 26 | 27 | `cheat fetch` - When you feel like updating the sheets. 28 | 29 | # Todo 30 | 31 | * Autocomplete commands and available cheats for bash and zsh 32 | 33 | * Allow multiple cheat directories 34 | * `cheat fetch` command to fetch all the cheatsheets from a repo. 35 | 36 | * Or execute a command by, `cheat git 12` ? 37 | * Colors on the AppHelpTemplate. 38 | * User's favorite editor, with support for command line parameters. 39 | 40 | * Wrap the output to a fit width? like 79 characters? 41 | 42 | * Update cheat sheets from chris' repo, `cheat --update` for updating it the safe way, and `cheat --update --force` for overwriting all the cheats with the downloaded version. 43 | 44 | * Should grep support be added? or can that be achived by `grep`ping things? 45 | 46 | # Places that have sheets 47 | 48 | * [Chris' Repo](https://github.com/chrisallenlane/cheat/tree/master/cheat/cheatsheets) 49 | * [Command Line Fu](http://www.commandlinefu.com/site/api) 50 | * [bro pages](http://bropages.org/browse) 51 | * [Markdown Cheatsheets](https://github.com/rstacruz/cheatsheets) 52 | * [Kapeli's Sheets](https://github.com/Kapeli/cheatsheets) 53 | * [Git Cheat](https://github.com/0xAX/git-cheat) 54 | * [More Sheets](https://github.com/Dmitrii-I/cheat) 55 | 56 | # Prior Art 57 | 58 | * [/chrisallenlane/cheat](http://github.com/chrisallenlane/cheat) in Python 59 | * [/jahendrie/cheat](https://github.com/jahendrie/cheat) in Bash 60 | * [/lucaswerkmeister/cheats](https://github.com/lucaswerkmeister/cheats) in Bash 61 | * [/defunkt/cheat](https://github.com/defunkt/) in Ruby 62 | * [/torsten/cheat](https://github.com/torsten/cheat) in Ruby (single file) 63 | * [/arthurnn/cheatly](https://github.com/arthurnn/cheatly) in Ruby 64 | 65 | * [Bro Pages](https://github.com/hubsmoke/bro/) 66 | * [tldr; Pages](https://github.com/tldr-pages/tldr) 67 | -------------------------------------------------------------------------------- /cheat.go: -------------------------------------------------------------------------------- 1 | // Create and view command-line cheatsheets. 2 | // A Go reimplementation of Chris Lane's python script. 3 | package main 4 | 5 | import ( 6 | "bufio" 7 | "fmt" 8 | "io" 9 | "io/ioutil" 10 | "net/url" 11 | "os" 12 | "os/exec" 13 | "os/user" 14 | "path/filepath" 15 | "regexp" 16 | "strconv" 17 | "strings" 18 | 19 | "github.com/atotto/clipboard" 20 | "github.com/mattn/go-colorable" 21 | "github.com/urfave/cli" 22 | ) 23 | 24 | const version string = "0.5" 25 | 26 | var ( 27 | stdout = colorable.NewColorableStdout() 28 | ) 29 | 30 | func main() { 31 | app := cli.NewApp() 32 | 33 | // Use our custom templates 34 | cli.AppHelpTemplate = AppHelpTemplate 35 | 36 | app.Name = "cheat" 37 | app.Usage = "Create and view command-line cheatsheets." 38 | app.Version = version 39 | 40 | config := &JSONData{} 41 | config.ReadConfig() 42 | 43 | app.Commands = []cli.Command{ 44 | { 45 | Name: "show", 46 | Aliases: []string{"s"}, 47 | Usage: "Show cheats related to a command", 48 | Flags: []cli.Flag{ 49 | cli.IntFlag{ 50 | Name: "copy, c", 51 | Usage: "cheat number to copy", 52 | }, 53 | }, 54 | Action: func(c *cli.Context) { 55 | var cmdname = c.Args().First() 56 | var cheatfile = filepath.Join(config.Cheatdirs[0], cmdname) 57 | 58 | if _, err := os.Stat(cheatfile); os.IsNotExist(err) { 59 | fmt.Fprintf(os.Stderr, "No cheatsheet found for '%s'\n", cmdname) 60 | fmt.Fprintf(os.Stderr, "To create a new sheet, run: cheat edit %s\n", cmdname) 61 | os.Exit(1) 62 | } else { 63 | if c.Int("copy") != 0 { 64 | copyCheat(cheatfile, cmdname, c.Int("copy")) 65 | } else { 66 | showCheats(cheatfile, cmdname) 67 | } 68 | } 69 | }, 70 | }, 71 | { 72 | Name: "edit", 73 | Aliases: []string{"e"}, 74 | Usage: "Add/Edit a cheat", 75 | Action: func(c *cli.Context) { 76 | var cheatfile = filepath.Join(config.Cheatdirs[0], c.Args().First()) 77 | editCheat(cheatfile, config.Editor) 78 | }, 79 | }, 80 | { 81 | Name: "list", 82 | Aliases: []string{"l"}, 83 | Usage: "List all available cheats", 84 | Action: func(c *cli.Context) { 85 | files, _ := ioutil.ReadDir(config.Cheatdirs[0]) 86 | for _, f := range files { 87 | fmt.Println(f.Name()) 88 | } 89 | }, 90 | }, 91 | { 92 | Name: "config", 93 | Usage: "Edit the config file", 94 | Action: func(c *cli.Context) { 95 | usr, _ := user.Current() 96 | rcfile := filepath.Join(usr.HomeDir, ".cheatrc") 97 | editCheat(rcfile, config.Editor) 98 | }, 99 | }, 100 | { 101 | Name: "fetch", 102 | Usage: "Fetch cheats from Github", 103 | Flags: []cli.Flag{ 104 | cli.StringFlag{ 105 | Name: "dir, d", 106 | Value: config.Cheatdirs[0], 107 | Usage: "cheats directory", 108 | }, 109 | cli.StringFlag{ 110 | Name: "repo, r", 111 | Value: "https://github.com/chrisallenlane/cheat/cheat/cheatsheets", 112 | Usage: "repository to fetch cheats from", 113 | }, 114 | cli.StringFlag{ 115 | Name: "local, l", 116 | Usage: "local path to store repository", 117 | }, 118 | }, 119 | Action: func(c *cli.Context) { 120 | if c.String("local") == "" && os.Getenv("GOPATH") == "" { 121 | fmt.Fprintf(os.Stderr, "Local path to store repo is required.\n") 122 | return 123 | } 124 | 125 | fetchCheats(c) 126 | }, 127 | }, 128 | } 129 | 130 | app.Run(os.Args) 131 | } 132 | 133 | func copyCheat(cheatfile string, cmdname string, cheatno int) { 134 | file, _ := os.Open(cheatfile) 135 | scanner := bufio.NewScanner(file) 136 | 137 | var i = 0 138 | for scanner.Scan() { 139 | line := strings.TrimSpace(scanner.Text()) 140 | 141 | if strings.HasPrefix(line, cmdname) { 142 | i++ 143 | } 144 | 145 | if cheatno == i { 146 | re := regexp.MustCompile(`([^#]*)`) 147 | res := re.FindAllStringSubmatch(line, -1) 148 | line = strings.TrimSpace(res[0][0]) 149 | clipboard.WriteAll(line) 150 | fmt.Fprintln(stdout, "\x1b[32;5m"+"Copied to Clipboard: "+"\x1b[0m"+line) 151 | break 152 | } 153 | } 154 | file.Close() 155 | } 156 | 157 | func showCheats(cheatfile string, cmdname string) { 158 | file, _ := os.Open(cheatfile) 159 | scanner := bufio.NewScanner(file) 160 | 161 | var i = 1 162 | for scanner.Scan() { 163 | line := strings.TrimSpace(scanner.Text()) 164 | 165 | // Pretty print the output 166 | // Todo: Will have to be tested on other platforms and terminals. 167 | 168 | if strings.HasPrefix(line, "#") { 169 | fmt.Fprintln(stdout, "\x1b[33;5m"+line+"\x1b[0m") 170 | } else if len(line) > 0 { 171 | fmt.Fprintln(stdout, "\x1b[36;5m("+strconv.Itoa(i)+")\x1b[0m "+line) 172 | i++ 173 | } else { 174 | fmt.Fprintln(stdout, line) 175 | } 176 | } 177 | file.Close() 178 | } 179 | 180 | func editCheat(cheatfile string, configEditor string) { 181 | editor, err := exec.LookPath(configEditor) 182 | 183 | if err != nil { 184 | fmt.Fprintf(os.Stderr, "Editor not found: %s", editor) 185 | } 186 | 187 | cmd := exec.Command(editor, cheatfile) 188 | cmd.Stdout = os.Stdout 189 | cmd.Stdin = os.Stdin 190 | cmd.Stderr = os.Stderr 191 | cmd.Run() 192 | } 193 | 194 | func fetchCheats(c *cli.Context) { 195 | // parse repo url 196 | repo, err := url.Parse(c.String("repo")) 197 | if err != nil { 198 | fmt.Fprintln(os.Stderr, err) 199 | return 200 | } 201 | 202 | repoPath := strings.Split(repo.Path, "/") 203 | if len(repoPath) <= 3 { 204 | fmt.Fprintln(os.Stderr, "Invalid Repo URL") 205 | return 206 | } 207 | 208 | cheatsPath := repoPath[3:] 209 | repo.Path = fmt.Sprintf("/%s/%s", repoPath[1], repoPath[2]) 210 | 211 | // directory where the cloned repository is stored 212 | var cloneDir string 213 | if c.String("local") != "" { 214 | cloneDir = c.String("local") 215 | } else if os.Getenv("GOPATH") != "" { 216 | cloneDir = filepath.Join(os.Getenv("GOPATH"), "src", repo.Host, repoPath[1], repoPath[2]) 217 | } 218 | 219 | // update the repo 220 | updated, err := updateLocalRepo(repo.String(), cloneDir) 221 | if err != nil { 222 | fmt.Fprintln(os.Stderr, err) 223 | return 224 | } 225 | 226 | // copy cheats 227 | if updated { 228 | srcPath := cloneDir 229 | for _, p := range cheatsPath { 230 | srcPath = filepath.Join(srcPath, p) 231 | } 232 | 233 | count, err := copyCheatFiles(srcPath, c.String("dir")) 234 | if err != nil { 235 | fmt.Fprintln(os.Stderr, err) 236 | } 237 | fmt.Fprintf(os.Stderr, "%d cheats updated.\n", count) 238 | } else { 239 | fmt.Fprintf(os.Stderr, "No cheats updated.\n") 240 | } 241 | } 242 | 243 | func updateLocalRepo(url, dir string) (bool, error) { 244 | var cmd *exec.Cmd 245 | 246 | _, err := os.Stat(dir) 247 | if os.IsNotExist(err) { 248 | cmd = exec.Command("git", "clone", url, dir) 249 | cmd.Stdout = os.Stdout 250 | cmd.Stderr = os.Stderr 251 | return true, cmd.Run() 252 | } else { 253 | cmd = exec.Command("git", "pull", url) 254 | cmd.Dir = dir 255 | 256 | out, err := cmd.CombinedOutput() 257 | if err != nil { 258 | return false, err 259 | } 260 | 261 | res := string(out) 262 | fmt.Fprint(os.Stderr, res) 263 | 264 | updated := true 265 | if strings.Contains(res, "Already up-to-date.") { 266 | updated = false 267 | } 268 | 269 | return updated, nil 270 | } 271 | } 272 | 273 | func copyCheatFiles(cloneDir, cheatsDir string) (int, error) { 274 | fmt.Fprintf(os.Stderr, "Copying from %s to %s\n", cloneDir, cheatsDir) 275 | count := 0 276 | 277 | files, err := ioutil.ReadDir(cloneDir) 278 | if err != nil { 279 | return count, err 280 | } 281 | 282 | err = os.MkdirAll(cheatsDir, 0755) 283 | if err != nil { 284 | return count, err 285 | } 286 | 287 | for _, f := range files { 288 | count += 1 289 | 290 | err := copyFile(filepath.Join(cloneDir, f.Name()), filepath.Join(cheatsDir, f.Name())) 291 | if err != nil { 292 | return count, err 293 | } 294 | } 295 | 296 | return count, nil 297 | } 298 | 299 | func copyFile(src, dst string) error { 300 | s, err := os.Open(src) 301 | if err != nil { 302 | return err 303 | } 304 | defer s.Close() 305 | 306 | d, err := os.Create(dst) 307 | if err != nil { 308 | return err 309 | } 310 | defer d.Close() 311 | 312 | if _, err := io.Copy(d, s); err != nil { 313 | return err 314 | } 315 | 316 | return nil 317 | } 318 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | {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 | . --------------------------------------------------------------------------------