Gitiles
Code Review Sign In
gerrit.named-data.net / NFD / 543b1524ec0de506fc94b145de19b3dcdd0d950a / . / docs / manpages / nfdc.rst
blob: 2e5d089e443cc0357b601c691ef472d2885b47df [file] [log] [blame]
hilata6ee6e072014-04-20 17:10:18 -0500[diff] [blame]1nfdc
2====
3
Davide Pesavento543b1522024-06-25 17:00:32 -0400[diff] [blame^]4Synopsis
hilata6ee6e072014-04-20 17:10:18 -0500[diff] [blame]5--------
6
Davide Pesavento543b1522024-06-25 17:00:32 -0400[diff] [blame^]7| **nfdc** *COMMAND* [*ARGUMENTS*]...
8| **nfdc** **help** [*COMMAND*]
9| **nfdc** [**-h**\|\ **\--help**]
10| **nfdc** **-V**\|\ **\--version**
11| **nfdc** **-f**\|\ **\--batch** *file*
12
13Description
Junxiao Shi15902ef2017-08-11 22:58:35 +0000[diff] [blame]14-----------
hilata6ee6e072014-04-20 17:10:18 -0500[diff] [blame]15
Davide Pesavento543b1522024-06-25 17:00:32 -0400[diff] [blame^]16:program:`nfdc` is a command-line tool to manage a running instance of NFD.
Junxiao Shi15902ef2017-08-11 22:58:35 +0000[diff] [blame]17
Davide Pesavento543b1522024-06-25 17:00:32 -0400[diff] [blame^]18All features of :program:`nfdc` are organized into subcommands.
19To print a list of all subcommands, run ``nfdc`` without arguments.
20To show how to use a subcommand, run ``nfdc help`` followed by the subcommand name.
21
22Options
Junxiao Shi15902ef2017-08-11 22:58:35 +0000[diff] [blame]23-------
Junxiao Shi15902ef2017-08-11 22:58:35 +0000[diff] [blame]24
Davide Pesavento543b1522024-06-25 17:00:32 -0400[diff] [blame^]25.. option:: <COMMAND>
26
27 A subcommand name. It usually contains a noun and a verb.
28
29.. option:: <ARGUMENTS>
30
Junxiao Shi15902ef2017-08-11 22:58:35 +0000[diff] [blame]31 Arguments to the subcommand.
32
Davide Pesavento543b1522024-06-25 17:00:32 -0400[diff] [blame^]33.. option:: -h, --help
34
Davide Pesaventoe0bae0f2018-02-17 22:07:52 -0500[diff] [blame]35 Print a list of available subcommands and exit.
Junxiao Shi15902ef2017-08-11 22:58:35 +0000[diff] [blame]36
Davide Pesavento543b1522024-06-25 17:00:32 -0400[diff] [blame^]37.. option:: -V, --version
38
Davide Pesaventoe0bae0f2018-02-17 22:07:52 -0500[diff] [blame]39 Show version information and exit.
Junxiao Shi15902ef2017-08-11 22:58:35 +0000[diff] [blame]40
Davide Pesavento543b1522024-06-25 17:00:32 -0400[diff] [blame^]41.. option:: -f <file>, --batch <file>
Alexander Afanasyevc414ca52021-06-09 12:15:19 -0400[diff] [blame]42
Davide Pesavento543b1522024-06-25 17:00:32 -0400[diff] [blame^]43 Process the list of arguments specified in *file* as if they would have appeared on
44 the command line.
45 When running a sequence of commands in rapid succession from a script, this option
46 ensures that the commands are properly timestamped and can therefore be accepted
47 by NFD.
Alexander Afanasyevc414ca52021-06-09 12:15:19 -0400[diff] [blame]48
Davide Pesavento543b1522024-06-25 17:00:32 -0400[diff] [blame^]49 When necessary, arguments should be escaped using a backslash (``\``), single quotes
50 (``'``), or double quotes (``"``).
51 If any of the commands fail, processing will stop at that command and :program:`nfdc`
52 will exit with error code 2.
53 Empty lines and lines that start with the ``#`` character are ignored.
54 Note that the batch file does not support empty string arguments (``""`` or ``''``),
55 even if they would normally be supported on the regular command line of :program:`nfdc`.
56
57Examples
Junxiao Shi15902ef2017-08-11 22:58:35 +0000[diff] [blame]58--------
Davide Pesavento543b1522024-06-25 17:00:32 -0400[diff] [blame^]59
60``nfdc``
Junxiao Shi0e13e1e2018-01-22 08:29:12 +0000[diff] [blame]61 List all subcommands.
hilata6ee6e072014-04-20 17:10:18 -0500[diff] [blame]62
Davide Pesavento543b1522024-06-25 17:00:32 -0400[diff] [blame^]63``nfdc help face create``
Junxiao Shi0e13e1e2018-01-22 08:29:12 +0000[diff] [blame]64 Show how to use the ``nfdc face create`` subcommand.
Junxiao Shi15902ef2017-08-11 22:58:35 +0000[diff] [blame]65
Davide Pesavento543b1522024-06-25 17:00:32 -0400[diff] [blame^]66See Also
Junxiao Shi15902ef2017-08-11 22:58:35 +0000[diff] [blame]67--------
Davide Pesavento543b1522024-06-25 17:00:32 -0400[diff] [blame^]68
69:manpage:`nfd(1)`,
70:manpage:`nfdc-cs(1)`,
71:manpage:`nfdc-face(1)`,
72:manpage:`nfdc-route(1)`,
73:manpage:`nfdc-status(1)`,
74:manpage:`nfdc-strategy(1)`