summaryrefslogtreecommitdiffstats
path: root/hicn-light
diff options
context:
space:
mode:
authorAngelo Mantellini <manangel@cisco.com>2019-03-20 11:03:25 +0100
committerAngelo Mantellini <manangel@cisco.com>2019-03-20 14:49:36 +0100
commitd0111c2f8b5b73739f7193a79415e1d0bc8ee8c8 (patch)
tree6422f7126c5200e384b7cc34a15dc79a8a54d3bb /hicn-light
parentd9b0f33a36f0f3f345d1059a82d725002780ca96 (diff)
[HICN-128] README utils and renaming of executables
Change-Id: I5e3cd78306d9f4a25197b54ca5b2779e600891c8 Signed-off-by: Angelo Mantellini <manangel@cisco.com>
Diffstat (limited to 'hicn-light')
-rw-r--r--hicn-light/CMakeLists.txt4
-rw-r--r--hicn-light/README.md61
-rw-r--r--hicn-light/src/command_line/daemon/hicnLightDaemon_main.c4
3 files changed, 34 insertions, 35 deletions
diff --git a/hicn-light/CMakeLists.txt b/hicn-light/CMakeLists.txt
index eb6a50121..4bebb76d7 100644
--- a/hicn-light/CMakeLists.txt
+++ b/hicn-light/CMakeLists.txt
@@ -56,8 +56,8 @@ if(CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR)
find_package_wrapper(Libhicn REQUIRED)
find_package_wrapper(Libparc REQUIRED)
set(LIBHICN_LIGHT hicn-light)
- set(HICN_LIGHT_CONTROL hicnLightControl)
- set(HICN_LIGHT_DAEMON hicnLightDaemon)
+ set(HICN_LIGHT_CONTROL hicn-light-control)
+ set(HICN_LIGHT_DAEMON hicn-light-daemon)
else()
set(HICN_LIBRARIES ${LIBHICN_SHARED})
set(DEPENDENCIES
diff --git a/hicn-light/README.md b/hicn-light/README.md
index ba7ed77b3..974cad1fe 100644
--- a/hicn-light/README.md
+++ b/hicn-light/README.md
@@ -33,67 +33,66 @@ Basic dependencies:
## hicn-light Executables ##
-hicn-light is a set of binary executables that are used to run a forwarder instance.
+hicn-light is a set of binary executables that are used to run a forwarder instance.
The forwarder can be run and configured using the commands
-- `hicnLightDaemon`
-- `hicnLightControl`
+- `hicn-light-daemon`
+- `hicn-light-control`
Use the `-h` option to display the help messages
### hicn-light Daemon ###
-The command `hicnLightDaemon` runs the hicn-light forwarder. The forwarder can be executed
+The command `hicn-light-daemon` runs the hicn-light forwarder. The forwarder can be executed
with the following options:
```
-hicnLightDaemon [--port port] [--daemon] [--capacity objectStoreSize] [--log facility=level]
+hicn-light-daemon [--port port] [--daemon] [--capacity objectStoreSize] [--log facility=level]
[--log-file filename] [--config file]
Options:
-
---port = tcp port for local in-bound connections
---daemon = start as daemon process
---capacity = maximum number of content objects to cache. To disable the cache
- objectStoreSize must be 0.
- Default vaule for objectStoreSize is 100000
---log = sets a facility to a given log level. You can have multiple of these.
- facilities: all, config, core, io, message, processor
- levels: debug, info, notice, warning, error, critical, alert, off
- example: hicnLightDaemon --log io=debug --log core=off
---log-file = file to write log messages to (required in daemon mode)
---config = configuration filename
-```
-
-The configuration file contains configuration lines as per hicnLightControl (see below for all
+--port <tcp_port> = tcp port for local in-bound connections
+--daemon = start as daemon process
+--capacity <capacity> = maximum number of content objects to cache. To disable the cache
+ objectStoreSize must be 0.
+ Default vaule for objectStoreSize is 100000
+--log <log_granularity> = sets a facility to a given log level. You can have multiple of these.
+ facilities: all, config, core, io, message, processor
+ levels: debug, info, notice, warning, error, critical, alert, off
+ example: hicn-light-daemon --log io=debug --log core=off
+--log-file <output_logfile> = file to write log messages to (required in daemon mode)
+--config <config_path> = configuration filename
+```
+
+The configuration file contains configuration lines as per hicn-light-control (see below for all
the available commands). If logging level or content store capacity is set in the configuration
file, it overrides the command_line. When a configuration file is specified, no default listeners
are setup. Only 'add listener' lines in the configuration file matter.
-If no configuration file is specified, hicnLightDaemon will listen on TCP and UDP ports specified
+If no configuration file is specified, hicn-light-daemon will listen on TCP and UDP ports specified
by the --port flag (or default port). It will listen on both IPv4 and IPv6 if available. The
default port for hicn-light is 9695. Commands are expected on port 2001.
-### hicn-light Control ###
+### hicn-light-control ###
-`hicnLightControl` can be used to send command to the hicn-light forwarder and configure it.
+`hicn-light-control` can be used to send command to the hicn-light forwarder and configure it.
The command can be executed in the following way:
```
-hicnLightControl [commands]
+hicn-light-control [commands]
Options:
- -h = This help screen
- commands = configuration line to send to hicn-light (use 'help' for list)
+ -h = This help screen
+ commands = configuration line to send to hicn-light (use 'help' for list)
```
-#### Available Commands in hicn-light Control ####
+#### Available Commands in hicn-light-control ####
-This is the full list of available commands in `hicnLightControl`. This commands can be used
-from the command line running `hicnLightControl` as explained before, or listing them in a
+This is the full list of available commands in `hicn-light-control`. This commands can be used
+from the command line running `hicn-light-control` as explained before, or listing them in a
configuration file.
-Information about the commands are also available in the `hicnLightControl` help message.
+Information about the commands are also available in the `hicn-light-control` help message.
`add listener`: creates a TCP or UDP listener with the specified options on the local forwarder.
For local connections (application to hicn-light) we expect a TCP listener. The default port for
@@ -267,7 +266,7 @@ mapme retx <milliseconds>
### hicn-light Configuration File Example ###
This is an example of a simple configuration file for hicn-light. It can be loaded by running
-the command `hicnLightDaemon --config configFile.cfg`, assuming the file name is configFile.cfg
+the command `hicn-light-daemon --config configFile.cfg`, assuming the file name is configFile.cfg
```
#create a local listener on port 9199. This will be used by the applications to talk
diff --git a/hicn-light/src/command_line/daemon/hicnLightDaemon_main.c b/hicn-light/src/command_line/daemon/hicnLightDaemon_main.c
index 39e57ad9e..14192618b 100644
--- a/hicn-light/src/command_line/daemon/hicnLightDaemon_main.c
+++ b/hicn-light/src/command_line/daemon/hicnLightDaemon_main.c
@@ -86,11 +86,11 @@ static void _displayForwarderLogo(void) {
static void _usage(int exitCode) {
#ifndef _WIN32
printf(
- "Usage: daemon [--port port] [--capacity objectStoreSize] "
+ "Usage: hicn-light-daemon [--port port] [--capacity objectStoreSize] "
"[--log facility=level] [--log-file filename] [--config file]\n");
#else
printf(
- "Usage: daemon [--port port] [--daemon] [--capacity objectStoreSize] "
+ "Usage: hicn-light-daemon.exe [--port port] [--daemon] [--capacity objectStoreSize] "
"[--log facility=level] [--log-file filename] [--config file]\n");
#endif
printf("\n");