diff options
Diffstat (limited to 'metis/documentation/manpage/metis_control.1.txt')
| -rw-r--r-- | metis/documentation/manpage/metis_control.1.txt | 87 |
1 files changed, 87 insertions, 0 deletions
diff --git a/metis/documentation/manpage/metis_control.1.txt b/metis/documentation/manpage/metis_control.1.txt new file mode 100644 index 00000000..ffeac009 --- /dev/null +++ b/metis/documentation/manpage/metis_control.1.txt @@ -0,0 +1,87 @@ + mmeettiiss__ccoonnttrrooll (1)General Commands Manual mmeettiiss__ccoonnttrrooll (1) + + + +NNAAMMEE + mmeettiiss__ccoonnttrrooll -- Metis is the CCNx 1.0 forwarder, which runs on each + end system and as a software forwarder on intermediate systems. + mmeettiiss__ccoonnttrrooll is the program to configure the forwarder, mmeettiiss__ddaaeemmoonn. + + +SSYYNNOOPPSSIISS + mmeettiiss__ccoonnttrrooll [----kkeeyyssttoorree _k_e_y_s_t_o_r_e] [----ppaasssswwoorrdd _p_a_s_s_w_o_r_d] [command- + line] + +DDEESSCCRRIIPPTTIIOONN + mmeettiiss__ccoonnttrrooll is the program used to configure a running forwarder + mmeettiiss__ddaaeemmoonn. It will connect to the forwarder over a local listener + (e.g. TCP to localhost or a unix domain socket). If a _c_o_m_m_a_n_d_l_i_n_e + option is specified, mmeettiiss__ccoonnttrrooll will send that one command to + Metis and then exit. If no _c_o_m_m_a_n_d_l_i_n_e is specified, mmeettiiss__ccoommmmaanndd + will enter interacitve mode where the user can issue multiple commands. + + + mmeettiiss__ccoonnttrrooll requires a signing keystore for communicating over the + network. The _k_e_y_s_t_o_r_e file is a standard PKCS12 keystore, and may be + created using ppaarrcc__ppuubblliicckkeeyy((11)). If no _k_e_y_s_t_o_r_e is specified, + mmeettiiss__ccoonnttrrooll will look in the standard path ~/.ccnx/.ccnx_key- + store.p12. The keystore password is specified in _p_a_s_s_w_o_r_d. If not + specified, no password is used. If the keystore does not open, the + user will be prompted for a password. + + + See mmeettiiss..ccffgg((55)) for a specification of the available _c_o_m_m_a_n_d_l_i_n_e. + + + The environment variable METIS_PORT may be used to specify what TCP + port to use to connect to the local Metis. The environment variable + METIS_LOCALPATH may be used to specific the UNIX domain socket to con- + nect to the local Metis and takes priority over METIS_PORT. + + +OOPPTTIIOONNSS + --keystore _k_e_y_s_t_o_r_e + mmeettiiss__ccoonnttrrooll requires a signing keystore for communicating + over the network. The _k_e_y_s_t_o_r_e file is a standard PKCS12 + keystore, and may be created using ppaarrcc__ppuubblliicckkeeyy((11)). If no + _k_e_y_s_t_o_r_e is specified, mmeettiiss__ccoonnttrrooll will + look in the standard path ~/.ccnx/.ccnx_keystore.p12. + + + --password _p_a_s_s_w_o_r_d + The keystore password is specified in _p_a_s_s_w_o_r_d. If not spec- + ified, no password is used. If the keystore does not open, + the user will be prompted for a password. + + + commandline + The remainder of the arguments are the commandline to send to + Metis. See USAGE. + + +UUSSAAGGEE + mmeettiiss__ccoonnttrrooll --keystore keystore.p12 + + + mmeettiiss__ccoonnttrrooll --keystore keystore.p12 list interfaces + + +SSEEEE AALLSSOO + See ppaarrcc__ppuubblliicckkeeyy((11)) for a utility to create a PKCS keystore. + + + For a list of all configuration lines that may be used with mmeettiiss__ccoonn-- + ttrrooll and by _-_-_c_o_n_f_i_g configuration file, see mmeettiiss..ccffgg((55)). + + + The default keystore is ~/.ccnx/.ccnx_keystore.p12. + + +CCAAVVEEAATTSS +BBUUGGSS +AAUUTTHHOORR + Marc Mosko Palo Alto Research Center + + + + mmeettiiss__ccoonnttrrooll (1) |