diff options
author | Case Duckworth | 2022-07-06 21:36:40 -0500 |
---|---|---|
committer | Case Duckworth | 2022-07-06 21:36:40 -0500 |
commit | 6948e57295bfe44f15a1a238756c008aef6bad7b (patch) | |
tree | 8422851bfb8b15659db5ffc60efa738dd34d71f3 /README.md | |
parent | Update documentation (diff) | |
download | licensor-6948e57295bfe44f15a1a238756c008aef6bad7b.tar.gz licensor-6948e57295bfe44f15a1a238756c008aef6bad7b.zip |
Fix spacing
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 68 |
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 | ``` |
16 | licensor: easily provide a license for a project | 16 | licensor: easily provide a license for a project |
17 | USAGE: licensor [-h|-l|-L] | 17 | USAGE: licensor [-h|-l|-L] |
18 | licensor -s QUERY | 18 | licensor -s QUERY |
19 | licensor [FLAGS] [OPTIONS] [LICENSE] | 19 | licensor [FLAGS] [OPTIONS] [LICENSE] |
20 | 20 | ||
21 | FLAGS: | 21 | FLAGS: |
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. |
25 | This 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 | ||
34 | OPTIONS: | 34 | OPTIONS: |
35 | -s QUERY Search for a license matching QUERY. | 35 | -s QUERY Search for a license matching QUERY. |
36 | Only 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. |
39 | Default: $(date +%Y). | 39 | Default: $(date +%Y). |
40 | -a AUTHORS Set copyright holder(s) to AUTHOR. | 40 | -a AUTHORS Set copyright holder(s) to AUTHOR. |
41 | Default: 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 | ||
56 | PARAMETERS: | 56 | PARAMETERS: |
57 | LICENSE The license to use. | 57 | LICENSE The license to use. |
58 | Default: MIT. | 58 | Default: MIT. |
59 | ``` | 59 | ``` |
60 | 60 | ||
61 | You can use an output file of `-` (i.e., `licensor -o-`) to print the license to | 61 | You can use an output file of `-` (i.e., `licensor -o-`) to print the license to |