Gitiles
Code Review Sign In
gerrit.named-data.net / ndn-cxx / 102f0570ec4810a60dbd0e590fccd6aeb3751c0a / . / docs / manpages / ndnsec-get-default.rst
blob: aa9e7d901264a60bf9a70c79696988839e128d9b [file] [log] [blame]
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]1ndnsec-get-default
2==================
3
Davide Pesaventob310efb2019-04-11 22:10:24 -0400[diff] [blame]4Synopsis
5--------
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]6
Davide Pesavento102f0572024-06-22 15:00:06 -0400[diff] [blame^]7**ndnsec get-default** [**-h**] [**-k**\|\ **-c**] [**-i** *identity*\|\ **-K** *key*]
8[**-q**]
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]9
10Description
11-----------
12
Davide Pesavento102f0572024-06-22 15:00:06 -0400[diff] [blame^]13This command shows the default settings of the local **Public Information Base (PIB)**
14or those of a specific PIB identity or key.
15
16By default, if neither :option:`-i` nor :option:`-K` is given, the command displays
17the default identity or the default key/certificate of the default identity.
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]18
19Options
20-------
21
Davide Pesaventob310efb2019-04-11 22:10:24 -0400[diff] [blame]22.. option:: -k, --default-key
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]23
Davide Pesaventob310efb2019-04-11 22:10:24 -0400[diff] [blame]24 Display the chosen entity's default key name.
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]25
Davide Pesaventob310efb2019-04-11 22:10:24 -0400[diff] [blame]26.. option:: -c, --default-cert
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]27
Davide Pesaventob310efb2019-04-11 22:10:24 -0400[diff] [blame]28 Display the chosen entity's default certificate name.
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]29
Davide Pesaventob310efb2019-04-11 22:10:24 -0400[diff] [blame]30.. option:: -i <identity>, --identity <identity>
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]31
Davide Pesaventob310efb2019-04-11 22:10:24 -0400[diff] [blame]32 Display default settings of *identity*.
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]33
Davide Pesaventob310efb2019-04-11 22:10:24 -0400[diff] [blame]34.. option:: -K <key>, --key <key>
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]35
Davide Pesaventob310efb2019-04-11 22:10:24 -0400[diff] [blame]36 Display default settings of *key*.
37
38.. option:: -q, --quiet
39
40 Disable printing the trailing newline character.
41
Davide Pesavento102f0572024-06-22 15:00:06 -0400[diff] [blame^]42Examples
43--------
Davide Pesaventob310efb2019-04-11 22:10:24 -0400[diff] [blame]44
45Display an identity's default key name::
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]46
Davide Pesavento102f0572024-06-22 15:00:06 -0400[diff] [blame^]47 $ ndnsec get-default -k -i /ndn/test/alice
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]48 /ndn/test/alice/ksk-1394129695025
49
Davide Pesaventob310efb2019-04-11 22:10:24 -0400[diff] [blame]50Display an identity's default certificate name::
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]51
Davide Pesavento102f0572024-06-22 15:00:06 -0400[diff] [blame^]52 $ ndnsec get-default -c -i /ndn/test/alice
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]53 /ndn/test/KEY/alice/ksk-1394129695025/ID-CERT/%FD%01D%98%9A%F2%3F
54
Davide Pesaventob310efb2019-04-11 22:10:24 -0400[diff] [blame]55Display a key's default certificate name::
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]56
Davide Pesavento102f0572024-06-22 15:00:06 -0400[diff] [blame^]57 $ ndnsec get-default -c -K /ndn/test/alice/ksk-1394129695025
Alexander Afanasyev151a8552014-04-11 00:54:43 -0700[diff] [blame]58 /ndn/test/KEY/alice/ksk-1394129695025/ID-CERT/%FD%01D%98%9A%F2%3F
Davide Pesavento102f0572024-06-22 15:00:06 -0400[diff] [blame^]59
60See Also
61--------
62
63:manpage:`ndnsec-list(1)`,
64:manpage:`ndnsec-set-default(1)`