@@ -24,7 +24,9 @@ To see the help text from the Terminal, execute the following command::
2424
2525 $ scancode --help
2626
27- The Following Help Text is displayed, i.e. This is the help text for Scancode Version 32.0.0::
27+ The Following Help Text is displayed, i.e. This is the help text for Scancode Version 32.0.0:
28+
29+ .. code-block :: none
2830
2931 Usage: scancode [OPTIONS] <OUTPUT FORMAT OPTION(s)> <input>...
3032
@@ -49,25 +51,25 @@ The Following Help Text is displayed, i.e. This is the help text for Scancode Ve
4951 -u, --url Scan <input> for urls.
5052
5153 scan options:
52- --license-diagnostics In license detections, include diagnostic details
54+ --license-diagnostics In license detections, include diagnostic details
5355 to figure out the license detection post
5456 processing steps applied.
55- --license-score INTEGER Do not return license matches with a score lower
57+ --license-score INTEGER Do not return license matches with a score lower
5658 than this score. A number between 0 and 100.
5759 [default: 0]
58- --license-text Include the detected licenses matched text.
59- --license-text-diagnostics In the matched license text, include diagnostic
60+ --license-text Include the detected licenses matched text.
61+ --license-text-diagnostics In the matched license text, include diagnostic
6062 highlights surrounding with square brackets []
6163 words that are not matched.
62- --license-url-template TEXT Set the template URL used for the license
64+ --license-url-template TEXT Set the template URL used for the license
6365 reference URLs. Curly braces ({}) are replaced by
6466 the license key. [default: https://scancode-
6567 licensedb.aboutcode.org/{}]
66- --max-email INT Report only up to INT emails found in a file. Use
68+ --max-email INT Report only up to INT emails found in a file. Use
6769 0 for no limit. [default: 50]
68- --max-url INT Report only up to INT urls found in a file. Use 0
70+ --max-url INT Report only up to INT urls found in a file. Use 0
6971 for no limit. [default: 50]
70- --unknown-licenses [EXPERIMENTAL] Detect unknown licenses.
72+ --unknown-licenses [EXPERIMENTAL] Detect unknown licenses.
7173
7274 output formats:
7375 --json FILE Write scan output as compact JSON to FILE.
@@ -89,25 +91,24 @@ The Following Help Text is displayed, i.e. This is the help text for Scancode Ve
8991 --cyclonedx-xml FILE Write scan output in CycloneDX XML format to FILE.
9092 --spdx-rdf FILE Write scan output as SPDX RDF to FILE.
9193 --spdx-tv FILE Write scan output as SPDX Tag/Value to FILE.
92- --html-app FILE (DEPRECATED: use the ScanCode Workbench app instead )
94+ --html-app FILE (DEPRECATED: use the ScanCode Workbench app instead)
9395 Write scan output as a mini HTML application to FILE.
9496
9597 output filters:
96- --ignore-author <pattern> Ignore a file (and all its findings) if an
97- author contains a match to the <pattern>
98- regular expression. Note that this will ignore
99- a file even if it has other findings such as a
100- license or errors.
101- --ignore-copyright-holder <pattern>
102- Ignore a file (and all its findings) if a
103- copyright holder contains a match to the
104- <pattern> regular expression. Note that this
105- will ignore a file even if it has other
106- scanned data such as a license or errors.
107- --only-findings Only return files or directories with findings
108- for the requested scans. Files and directories
109- without findings are omitted (file information
110- is not treated as findings).
98+ --ignore-author <pattern> Ignore a file (and all its findings) if an
99+ author contains a match to the <pattern>
100+ regular expression. Note that this will ignore
101+ a file even if it has other findings such as a
102+ license or errors.
103+ --ignore-copyright-holder <pattern> Ignore a file (and all its findings) if a
104+ copyright holder contains a match to the
105+ <pattern> regular expression. Note that this
106+ will ignore a file even if it has other
107+ scanned data such as a license or errors.
108+ --only-findings Only return files or directories with findings
109+ for the requested scans. Files and directories
110+ without findings are omitted (file information
111+ is not treated as findings).
111112
112113 output control:
113114 --full-root Report full, absolute paths.
@@ -118,65 +119,65 @@ The Following Help Text is displayed, i.e. This is the help text for Scancode Ve
118119 pre-scan:
119120 --ignore <pattern> Ignore files matching <pattern>.
120121 --include <pattern> Include files matching <pattern>.
121- --classify Classify files with flags telling if the file is a
122- legal, or readme or test file, etc .
122+ --classify Classify files with flags indicating whether the file is a
123+ legal, readme, test or similar file.
123124 --facet <facet>=<pattern> Add the <facet> to files with a path matching
124- <pattern>.
125+ <pattern>.
125126
126127 post-scan:
127128 --consolidate Group resources by Packages or license and copyright
128- holder and return those groupings as a list of
129- consolidated packages and a list of consolidated
130- components. This requires the scan to have/be run
131- with the copyright, license, and package options
132- active
129+ holder and return those groupings as a list of
130+ consolidated packages and a list of consolidated
131+ components. This requires the scan to have/be run
132+ with the copyright, license, and package options
133+ active
133134 --filter-clues Filter redundant duplicated clues already contained
134- in detected license and copyright texts and notices.
135+ in detected license and copyright texts and notices.
135136 --license-clarity-score Compute a summary license clarity score at the
136- codebase level.
137+ codebase level.
137138 --license-policy FILE Load a License Policy file and apply it to the scan
138- at the Resource level.
139+ at the Resource level.
139140 --license-references Return reference data for all licenses and license
140- rulespresent in detections.
141+ rules present in detections.
141142 --mark-source Set the "is_source" to true for directories that
142- contain over 90% of source files as children and
143- descendants. Count the number of source files in a
144- directory as a new source_file_counts attribute
143+ contain over 90% of source files as children and
144+ descendants. Count the number of source files in a
145+ directory as a new source_file_counts attribute
145146 --summary Summarize scans by providing declared origin
146- information and other detected origin info at the
147- codebase attribute level.
147+ information and other detected origin info at the
148+ codebase attribute level.
148149 --tallies Compute tallies for license, copyright and other
149- scans at the codebase level.
150+ scans at the codebase level.
150151 --tallies-by-facet Compute tallies for license, copyright and other
151- scans and group the results by facet.
152+ scans and group the results by facet.
152153 --tallies-key-files Compute tallies for license, copyright and other
153- scans for key, top-level files. Key files are top-
154- level codebase files such as COPYING, README and
155- package manifests as reported by the --classify
156- option "is_legal", "is_readme", "is_manifest" and
157- "is_top_level" flags.
154+ scans for key, top-level files. Key files are top-
155+ level codebase files such as COPYING, README and
156+ package manifests as reported by the --classify
157+ option "is_legal", "is_readme", "is_manifest" and
158+ "is_top_level" flags.
158159 --tallies-with-details Compute tallies of license, copyright and other scans
159- at the codebase level, keeping intermediate details
160- at the file and directory level.
160+ at the codebase level, keeping intermediate details
161+ at the file and directory level.
161162
162163 core:
163- --timeout <seconds> Stop an unfinished file scan after a timeout in
164+ --timeout <seconds> Stop an unfinished file scan after a timeout in
164165 seconds. [default: 120 seconds]
165- -n, --processes INT Set the number of parallel processes to use. Disable
166+ -n, --processes INT Set the number of parallel processes to use. Disable
166167 parallel processing if 0. Also disable threading if
167168 -1. [default: 1]
168- -q, --quiet Do not print summary or progress.
169- -v, --verbose Print progress as file-by-file path instead of a
169+ -q, --quiet Do not print summary or progress.
170+ -v, --verbose Print progress as file-by-file path instead of a
170171 progress bar. Print verbose scan counters.
171- --from-json Load codebase from one or more <input> JSON scan
172+ --from-json Load codebase from one or more <input> JSON scan
172173 file(s).
173- --max-in-memory INTEGER Maximum number of files and directories scan details
174+ --max-in-memory INTEGER Maximum number of files and directories scan details
174175 kept in memory during a scan. Additional files and
175176 directories scan details above this number are cached
176177 on-disk rather than in memory. Use 0 to use unlimited
177178 memory and disable on-disk caching. Use -1 to use
178179 only on-disk caching. [default: 10000]
179- --max-depth INTEGER Maximum nesting depth of subdirectories to scan.
180+ --max-depth INTEGER Maximum nesting depth of subdirectories to scan.
180181 Descend at most INTEGER levels of directories below
181182 and including the starting directory. Use 0 for no
182183 scan depth limit.
@@ -203,7 +204,7 @@ The Following Help Text is displayed, i.e. This is the help text for Scancode Ve
203204
204205 scancode --json-pp - --license --package samples
205206
206- Note: when you run scancode , a progress bar is displayed with a counter of the
207+ Note: when you run ScanCode , a progress bar is displayed with a counter of the
207208 number of files processed. Use --verbose to display file-by-file progress.
208209
209210cli_examples_text :
@@ -383,7 +384,8 @@ The Following Text is displayed, i.e. This is the available plugins for Scancode
383384 required_plugins:
384385 options:
385386 help_group: output formats, name: html_app: --html-app
386- help: (DEPRECATED: use the ScanCode Workbench app instead ) Write scan output as a mini HTML application to FILE.
387+ help: (DEPRECATED: use the ScanCode Workbench app instead)
388+ Write scan output as a mini HTML application to FILE.
387389 doc:
388390 Write scan output as a mini HTML application.
389391
0 commit comments