about summary refs log tree commit diff stats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md68
1 files changed, 34 insertions, 34 deletions
diff --git a/README.md b/README.md index 0e71ae5..0388017 100644 --- a/README.md +++ b/README.md
@@ -14,48 +14,48 @@ literally taken from `licensor -h`:
14 14
15``` 15```
16licensor: easily provide a license for a project 16licensor: easily provide a license for a project
17USAGE: licensor [-h|-l|-L] 17USAGE: licensor [-h|-l|-L]
18licensor -s QUERY 18licensor -s QUERY
19licensor [FLAGS] [OPTIONS] [LICENSE] 19licensor [FLAGS] [OPTIONS] [LICENSE]
20 20
21FLAGS: 21FLAGS:
22-h Display this help and exit. 22-h Display this help and exit.
23-l List available licenses and exit. 23-l List available licenses and exit.
24-L List available licenses, disregarding cache. 24-L List available licenses, disregarding cache.
25This flag will re-download the license repo. 25 This flag will re-download the license repo.
26 26
27-f Overwrite existing license. 27-f Overwrite existing license.
28-q Be quiet (don't log anything). 28-q Be quiet (don't log anything).
29-z Fold output to 70 characters (see -w). 29-z Fold output to 70 characters (see -w).
30-Z Disable folding of output. 30-Z Disable folding of output.
31-p Include "optional" license content. 31-p Include "optional" license content.
32-P Don't include "optional" content. 32-P Don't include "optional" content.
33 33
34OPTIONS: 34OPTIONS:
35-s QUERY Search for a license matching QUERY. 35-s QUERY Search for a license matching QUERY.
36Only license titles are searched. 36 Only license titles are searched.
37 37
38-y YEARS Set copyright date(s) to YEARS. 38-y YEARS Set copyright date(s) to YEARS.
39Default: $(date +%Y). 39 Default: $(date +%Y).
40-a AUTHORS Set copyright holder(s) to AUTHOR. 40-a AUTHORS Set copyright holder(s) to AUTHOR.
41Default: use the first of 41 Default: use the first of
42- git config --get user.name 42 - git config --get user.name
43 - getent password $USER 43 - getent password $USER
44 - $USER 44 - $USER
45 -e EMAILS Set AUTHOR's EMAIL address. 45 -e EMAILS Set AUTHOR's EMAIL address.
46 Default: $(git config --get user.email), 46 Default: $(git config --get user.email),
47 or stay blank. 47 or stay blank.
48 -c COPYRIGHT Set the entire COPYRIGHT string to print. 48 -c COPYRIGHT Set the entire COPYRIGHT string to print.
49 By default, it's built from the above information: 49 By default, it's built from the above information:
50 "Copyright (C) <year> <author> <email>". 50 "Copyright (C) <year> <author> <email>".
51 -w WIDTH Fold the output to WIDTH characters. 51 -w WIDTH Fold the output to WIDTH characters.
52 Default: 70. 52 Default: 70.
53 -o FILE Output the fetched license to FILE. 53 -o FILE Output the fetched license to FILE.
54 Default: $PWD/COPYING. 54 Default: $PWD/COPYING.
55 55
56PARAMETERS: 56PARAMETERS:
57 LICENSE The license to use. 57 LICENSE The license to use.
58 Default: MIT. 58 Default: MIT.
59``` 59```
60 60
61You can use an output file of `-` (i.e., `licensor -o-`) to print the license to 61You can use an output file of `-` (i.e., `licensor -o-`) to print the license to