Skip to content

Commit 55abd3f

Browse files
authored
Update general.rst
Signed-off-by: Chin Yeung Li <[email protected]>
1 parent 0d5fbbf commit 55abd3f

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

docs/source/general.rst

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -462,15 +462,32 @@ Here is an example of a attrib command:
462462

463463
Note that this example attrib command does the following:
464464

465-
- Activates the --template option to specify a custom output template.
465+
- Activates the ``--template`` option to specify a custom output template.
466466

467467
- Specifies the path of the ABOUT file(s) that use to generate the output attribution.
468468

469469
- Specifies the full path (include file name) of the output document to be generated.
470470

471+
Another example:
472+
473+
``about attrib /Users/harrypotter/inventory.xlsx
474+
/Users/harrypotter/attribution.html --reference /Users/harrypotter/licenses/``
475+
476+
The above command does the following:
477+
478+
- Use the ``inventory.xlsx`` as the input
479+
480+
- Specifies the location of the generated output document
481+
482+
- Specifies the licesen_file or notice_file location that can be found in the
483+
``--reference`` option
484+
485+
471486
A successful execution of attrib will create a .html (or .json depends on the template)
472487
file that is ready to use to meet your attribution requirements.
473488

489+
Please refer to the ``attrib`` section in :ref:`reference` for more information.
490+
474491
Using inventory to Generate a Software Inventory
475492
================================================
476493

0 commit comments

Comments
 (0)