General
The FOXMAN‑UN technical documentation is delivered together with the FOXMAN‑UN software. It is available in HTML format with PDFs included. It must be installed as a separate package before it can be used. Make sure the documentation collection is available on your machine, and run the installation script.
For viewing the HTML-based technical documentation a web browser is required.
A PDF reader is required for viewing PDFs included in the technical documentation. It must be installed in the default directory. If it does not already exist on the workstation, it can be downloaded from the Internet.
Access to technical documentation
The documentation can be called via the start icon or from a terminal using the command:
docviewer
This opens the top navigation page of the documentation from where all documents can be accessed. If the technical documentation has not been installed yet or a PDF reader is missing in the default directory, corresponding error messages are displayed.
Documentation contents
The technical documentation contains, among others, the following information:
System Description “FOXMAN‑UN”
This document provides a general description of the features and characteristics of FOXMAN‑UN. It also gives an overview of the installation and administration processes and the requirements of the hardware and software platform.
User Manual “FOXMAN‑UN Help”
This is the compiled version of the present document. It contains the complete information of the FOXMAN‑UN help system. It includes, among others, the help for the Basic Package, the Networking Package, and the Ethernet Networking Package.
User Manual “FOXMAN‑UN Networking Package”
This document provides the details for automatically or semi-automatically provisioning client connections across the complete network managed by the FOXMAN‑UN system.
User Manual “FOXMAN‑UN Northbound Interface” (SNMP)
This document gives an introduction to the northbound SNMP interface in FOXMAN‑UN.
User Manual “FOXMAN‑UN under Linux”
This document provides help with the administrative tasks and the available FOXMAN‑UN software tools on the workstation.
User Manual “FOXMAN‑UN under Windows”
This document provides help with the administrative tasks and the available FOXMAN‑UN software tools for the Windows® installed version of the FOXMAN‑UN client.
User Manual “FOXMAN‑UN Installation”
This document provides installation instructions for the FOXMAN‑UN and the relevant operating system.
Application Notes
Application Notes treat special or customer specific issues which are not part of the main documentation.
Please note:
The FOXMAN‑UN Release Note, providing details on the release contents and possible limitations, is not included in the technical documentation. It can be downloaded from the Hitachi Energy Publisher (https://publisher.hitachienergy.com).