vlib: add nosyslog unix option

[vpp.git] / docs / gettingstarted / users / configuring / startup.rst

diff --git a/docs/gettingstarted/users/configuring/startup.rst b/docs/gettingstarted/users/configuring/startup.rst
index 6ec2b97..69d6ee5 100644 (file)
--- a/docs/gettingstarted/users/configuring/startup.rst
+++ b/docs/gettingstarted/users/configuring/startup.rst
@@ -123,6 +123,18 @@ applications from a process monitor. Set by default in the default
 
    nodaemon
 
+nosyslog
+^^^^^^^^
+
+Disable syslog and log errors to stderr instead. Typical when invoking
+VPP applications from a process monitor like runit or daemontools that
+pipe service's output to a dedicated log service, which will typically
+attach a timestamp and rotate the logs as necessary.
+
+.. code-block:: console
+
+   nosyslog
+
 interactive
 ^^^^^^^^^^^
 
@@ -618,7 +630,7 @@ string of the form "DDDD:BB:SS.F" where:
 * SS = Slot number
 * F = Function
 
-If the keywork **default** is used the values will apply to all the devices.
+If the keyword **default** is used the values will apply to all the devices.
 
 This is the same format used in the linux sysfs tree (i.e./sys/bus/pci/devices)
 for PCI device directory names.
@@ -672,7 +684,7 @@ Number of receive queues. Also enables RSS. Default value is 1.
 .. code-block:: console
 
    dev 0000:02:00.1 {
-      num-tx-queues <n>
+      num-rx-queues <n>
    }
 
 num-tx-queues <n>
@@ -1044,6 +1056,20 @@ a random, non-static entry is deleted. Defaults to 65535 entries.
 
    max-cache-size 65535
 
+
+ethernet Section
+-----------------
+
+default-mtu <n>
+^^^^^^^^^^^^^^^
+
+Specifies the default MTU size for Ethernet interfaces.  Must be in
+the range of 64-9000.  The default is 9000.
+
+.. code-block:: console
+
+   default-mtu 1500
+
 heapsize Section
 -----------------
 
@@ -1054,9 +1080,7 @@ much of anything else.
 heapsize <n>M | <n>G
 ^^^^^^^^^^^^^^^^^^^^
 
-Specifies the size of the heap in MB or GB. The default is 1GB. Setting the
-main heap size to 4GB or more requires recompilation of the entire system
-with CLIB_VEC64 > 0. See .../clib/clib/vec_bootstrap.h.
+Specifies the size of the heap in MB or GB. The default is 1GB.
 
 .. code-block:: console
 
@@ -1328,7 +1352,7 @@ meaning the NAT is not deterministic.
    deterministic
 
 nat64 bib hash buckets <n>
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Sets the number of hash buckets in each of the two in/out NAT64 BIB bi-hash
 tables. Defaults to 1024 buckets.
@@ -1338,7 +1362,7 @@ tables. Defaults to 1024 buckets.
    nat64 bib hash buckets 1024
 
 nat64 bib hash memory <n>
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Sets the allocated memory size (in bytes) for each of the two in/out NAT64
 BIB bi-hash tables. Defaults to 134217728 (128 << 20) bytes,
@@ -1349,7 +1373,7 @@ which is roughly 128 MB.
    nat64 bib hash memory 134217728
 
 nat64 st hash buckets <n>
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Sets the number of hash buckets in each of the two in/out NAT64 session table
 bi-hash tables. Defaults to 2048 buckets.
@@ -1359,7 +1383,7 @@ bi-hash tables. Defaults to 2048 buckets.
    nat64 st hash buckets 2048
 
 nat64 st hash memory <n>
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^
 
 Sets the allocated memory size (in bytes) for each of the two in/out NAT64 session
 table bi-hash tables. Defaults to 268435456 (256 << 20) bytes, which is roughly
@@ -1397,6 +1421,32 @@ Default is 2.04 seconds.
 
    interval 3.5
 
+physmem Section
+---------------
+
+Configuration parameters used to specify base address and maximum size of
+the memory allocated for the pmalloc module in VPP. pmalloc is a NUMA-aware,
+growable physical memory allocator. pmalloc allocates memory for the DPDK
+memory pool.
+
+base-addr <address>
+^^^^^^^^^^^^^^^^^^^
+
+Specify the base address for pmalloc memory space.
+
+.. code-block:: console
+
+    base-addr 0xfffe00000000
+
+max-size <n>G | <n>M | <n>K | <n>
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Set the memory size for pmalloc memory space. The default is 16G.
+
+.. code-block:: console
+
+    max-size 4G
+
 tapcli Section
 --------------