afonso/core-extra
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

updates to doc regarding changes

Browse source
This commit is contained in:
Blake J. Harnden 2018-01-10 15:59:46 -08:00
parent 14312db02d
commit 3ba8371282
2 changed files with 23 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/devguide.rst
View file

@ -33,8 +33,9 @@ These are being actively developed as of CORE |version|:
* *gui* - Tcl/Tk GUI. This uses Tcl/Tk because of its roots with the IMUNES
project.
* *daemon* - Python modules are found in the :file:`daemon/core` directory, the
daemon under :file:`daemon/sbin/core-daemon`, and Python extension modules for
Linux Network Namespace support are in :file:`netns`.
daemon under :file:`daemon/sbin/core-daemon`
* *netns* - Python extension modules for Linux Network Namespace support are in :file:`netns`.
* *ns3* - Python ns3 script support for running CORE.
* *doc* - Documentation for the manual lives here in reStructuredText format.
* *packaging* - Control files and script for building CORE packages are here.

40
doc/install.rst
View file

@ -25,30 +25,23 @@ The primary dependencies are Tcl/Tk (8.5 or newer) for the GUI, and Python 2.6 o
.. index:: paths
.. index:: install paths
CORE files are installed to the following directories. When installing from
source, the :file:`/usr/local` prefix is used in place of :file:`/usr` by
default.
CORE files are installed to the following directories.
============================================= =================================
======================================================= =================================
Install Path Description
============================================= =================================
:file:`/usr/bin/core-gui` GUI startup command
:file:`/usr/sbin/core-daemon` Daemon startup command
:file:`/usr/sbin/` Misc. helper commands/scripts
:file:`/usr/lib/core` GUI files
:file:`/usr/lib/python2.7/dist-packages/core` Python modules for daemon/scripts
======================================================= =================================
:file:`/usr/local/bin/core-gui` GUI startup command
:file:`/usr/local/bin/core-daemon` Daemon startup command
:file:`/usr/local/bin/` Misc. helper commands/scripts
:file:`/usr/local/lib/core` GUI files
:file:`/usr/local/lib/python2.7/dist-packages/core` Python modules for daemon/scripts
:file:`/etc/core/` Daemon configuration files
:file:`~/.core/` User-specific GUI preferences and scenario files
:file:`/usr/share/core/` Example scripts and scenarios
:file:`/usr/share/man/man1/` Command man pages
:file:`/etc/init.d/core-daemon` System startup script for daemon
============================================= =================================
Under Fedora, :file:`/site-packages/` is used instead of :file:`/dist-packages/`
for the Python modules, and :file:`/etc/systemd/system/core-daemon.service`
instead of :file:`/etc/init.d/core-daemon` for the system startup script.
:file:`/usr/local/share/core/` Example scripts and scenarios
:file:`/usr/local/share/man/man1/` Command man pages
:file:`/etc/init.d/core-daemon` SysV startup script for daemon
:file:`/etc/systemd/system/core-daemon.service` Systemd startup script for daemon
======================================================= =================================
.. _Prerequisites:
@ -121,7 +114,8 @@ Installing from Packages
The easiest way to install CORE is using the pre-built packages. The package
managers on Ubuntu or Fedora will
automatically install dependencies for you.
You can obtain the CORE packages from the `CORE downloads <http://downloads.pf.itd.nrl.navy.mil/core/packages/>`_ page.
You can obtain the CORE packages from the `CORE downloads <http://downloads.pf.itd.nrl.navy.mil/core/packages/>`_ page
or `CORE GitHub <https://github.com/coreemu/core/releases>`_.
.. _Installing_from_Packages_on_Ubuntu:
@ -285,14 +279,14 @@ Fedora release number.
.. parsed-literal::
yum localinstall core-daemon-|version|-|CORERPM| --nogpgcheck
yum localinstall python-core_|service|-|version|-|CORERPM| --nogpgcheck
yum localinstall core-gui-|version|-|CORERPM2| --nogpgcheck
or install from the command-line:
.. parsed-literal::
rpm -ivh core-daemon-|version|-|CORERPM|
rpm -ivh python-core_|service|-|version|-|CORERPM|
rpm -ivh core-gui-|version|-|CORERPM2|