doc: update ns3 API

This commit is contained in:
Gabriel Ferreira
2022-01-13 23:59:59 -03:00
parent 330ffb75b6
commit 33f2ee841b
96 changed files with 281 additions and 298 deletions

View File

@@ -47,26 +47,26 @@ Other ns3 usages include:
2. ./ns3 configure --disable-python
Disable python bindings.
3. ./ns3 --doxygen
3. ./ns3 docs doxygen
Run doxygen to generate documentation
4. ./ns3 --run "program [args]"
4. ./ns3 run "program [args]"
Run a ns3 program, given its target name, with the given
arguments. This takes care of automatically modifying the
path for finding the ns3 dynamic libraries in the environment
before running the program. Note: the "program [args]" string is
parsed using POSIX shell rules.
4.1 ./ns3 --run programname --command-template "... %s ..."
4.1 ./ns3 run program-name --command-template "... %s ..."
Same as --run, but uses a command template with %s replaced by the
actual program (whose name is given by --run). This can be use to
Same as run, but uses a command template with %s replaced by the
actual program (whose name is given by run). This can be use to
run ns-3 programs with helper tools. For example, to run unit
tests with valgrind, use the command:
./ns3 --run run-tests --command-template "valgrind %s"
./ns3 run run-tests --command-template "valgrind %s"
5. ./ns3 --shell
5. ./ns3 shell
Starts a nested system shell with modified environment to run ns3 programs.
6. ./ns3 clean