src+docs: Clarifying README and remove unused option from usage
Refs: #1827
Change-Id: I171d7316548c0a94a81d9e8bdb73f6cdfc5f39f1
diff --git a/docs/INSTALL.md b/docs/INSTALL.md
index 1235e89..68981a3 100644
--- a/docs/INSTALL.md
+++ b/docs/INSTALL.md
@@ -39,7 +39,7 @@
On linux variants
- sudo apt-get install libprotobuf-dev
+ sudo apt-get install libprotobuf-dev protobuf-compiler
Build
diff --git a/docs/SECURITY.md b/docs/SECURITY.md
index c15dd60..4d72528 100644
--- a/docs/SECURITY.md
+++ b/docs/SECURITY.md
@@ -68,27 +68,26 @@
NOTE: The first two steps may not apply to everyone as the root certificate and the site certificate are usually present at a testbed outside the scope of NLSR. These steps will help if you are testing an isolated testbed.
1. Create root key and self signed certificate with prefis `/ndn`
- $ndnsec-key-gen -n /ndn
- $ndnsec-sign-req /ndn > root.cert
+ $ndnsec-key-gen -n /ndn > root.cert
This root.cert will be configured by "cert-to-publish" commands in nlsr.conf
2. Generate key for site prefix `/ndn/edu/memphis` and sign it by root key
- $ndnsec-key-gen -n /ndn/edu/memphis > unsigned_site.cert
+ $ndnsec-key-gen -n /ndn/edu/memphis > selfsigned_site.cert
$ndnsec-cert-gen -S 20140701000000 -E 20150701000000 -N "University of Memphis"
- -s /ndn -p /ndn/edu/memphis -r unsigned_site.cert > site.cert
+ -s /ndn -p /ndn/edu/memphis -r selfsigned_site.cert > site.cert
3. Generate key for operator and sign it by memphis site key. Lets assume that
operator name in Memphis site is ndnuser, so the prefix is `/ndn/edu/memphis/%C1.O.N./ndnuser`
- $ndnsec-key-gen -n /ndn/edu/memphis/%C1.Operator/ndnuser > unsigned_operator.cert
+ $ndnsec-key-gen -n /ndn/edu/memphis/%C1.Operator/ndnuser > selfsigned_operator.cert
$ndnsec-cert-gen -S 20140701000000 -E 20150701000000 -N "University of Memphis Operator"
-s /ndn/edu/memphis -p /ndn/edu/memphis/%C1.Operator/ndnuser
- -r unsigned_operator.cert > operator.cert
+ -r selfsigned_operator.cert > operator.cert
4. Generate key for router and sign it with operator's key
- $ndnsec-key-gen /ndn/edu/memphis/%C1.Router/router1 > unsigned_router.cert
+ $ndnsec-key-gen /ndn/edu/memphis/%C1.Router/router1 > selfsigned_router.cert
$ndnsec-cert-gen -S 20140701000000 -E 20150701000000 -N "University of Memphis Router"
-s /ndn/edu/memphis/%C1.Operator/ndnuser -p /ndn/edu/memphis/%C1.Router/router1
- -r unsigned_router.cert > router.cert
+ -r selfsigned_router.cert > router.cert
Key creation and signing is done for `/ndn/memphis.edu/router1`. In nlsr.conf
@@ -211,7 +210,7 @@
file-name "root.cert"
}
}
- cert-to-publish "root.cert" //optional, a file containing the root certificate. only the router
+ ;cert-to-publish "root.cert" //optional, a file containing the root certificate. only the router
//that is designated to publish root cert needs to specify this
cert-to-publish "site.cert" //optional, a file containing the root certificate. only the router
//that is designated to publish site cert need to specify this
@@ -226,7 +225,7 @@
site.
2. Generate key for site prefix `/ndn/edu/colorado`
- $ndnsec-key-gen -n /ndn/edu/memphis > unsigned_site.cert
+ $ndnsec-key-gen -n /ndn/edu/memphis > selfsigned_site.cert
Send this cert to Memphis site ( as in example Memphis is the root) and get
it signed by root. After you get back the site please put it in your convenient
@@ -237,13 +236,13 @@
$ndnsec-key-gen -n /ndn/edu/colorado/%C1.Operator/testop > unsigned_operator.cert
$ndnsec-cert-gen -S 20140701000000 -E 20150701000000 -N "Colorado State University Operator"
-s /ndn/edu/colorado -p /ndn/edu/colorado/%C1.Operator/testop
- -r unsigned_operator.cert > operator.cert
+ -r selfsigned_operator.cert > operator.cert
4. Generate key for router and sign it with operator's key
$ndnsec-key-gen /ndn/edu/colorado/%C1.Router/router2 > unsigned_router.cert
$ndnsec-cert-gen -S 20140701000000 -E 20150701000000 -N "Colorado State University Router"
-s /ndn/edu/colorado/%C1.Operator/testop -p /ndn/edu/colorado/%C1.Router/router2
- -r unsigned_router.cert > router.cert
+ -r selfsigned_router.cert > router.cert
Key creation and signing is done for `/ndn/edu/colorado/router2`. In nlsr.conf
diff --git a/nlsr.conf b/nlsr.conf
index 13d7b5b..948c67a 100644
--- a/nlsr.conf
+++ b/nlsr.conf
@@ -23,7 +23,7 @@
neighbors
{
-; in case hello interest timed out, router will try 'hello-retries' times at 'hello-time-out'
+; in case hello interest timed out, router will try 'hello-retries' times at 'hello-timeout'
; seconds interval before giving up for any neighbors (deciding link is down)
hello-retries 3 ; interest retries number in integer. Default value 3
diff --git a/src/nlsr.cpp b/src/nlsr.cpp
index e98def2..b9f9cb2 100644
--- a/src/nlsr.cpp
+++ b/src/nlsr.cpp
@@ -274,12 +274,11 @@
void
Nlsr::usage(const string& progname)
{
- cout << "Usage: " << progname << " [OPTIONS...]" << endl;
- cout << " NDN routing...." << endl;
- cout << " -d, --daemon Run in daemon mode" << endl;
- cout << " -f, --config_file Specify configuration file name" << endl;
- cout << " -p, --api_port port where api client will connect" << endl;
- cout << " -h, --help Display this help message" << endl;
+ std::cout << "Usage: " << progname << " [OPTIONS...]" << std::endl;
+ std::cout << " NDN routing...." << std::endl;
+ std::cout << " -d, --daemon Run in daemon mode" << std::endl;
+ std::cout << " -f, --config_file Specify configuration file name" << std::endl;
+ std::cout << " -h, --help Display this help message" << std::endl;
}