Documentation Nexus IQ Server 1.16

Our documentation site has moved. For the most current version, please see http://help.sonatype.com

Chapter 1. How to Use This Book

The Sonatype CLM Book you are reading right now is the first source of knowledge for using the different components of the Sonatype CLM suite of tools. It is separated into a number of different sections.

The navigation bar on the left-hand side of the documentation allows you to access all the different sections directly.

The top right-hand side of the documentation features a search input box that accesses all sections and documents to provide you with the relevant document for your search term.

A user interface label or button is highlighted. E.g. use the Applications button to access the list of applications in the CLM server.

A code segment or command line input in a paragraph would be looking like this mvn clean install.

Larger code segments are encapsulated in a block:

$tar xfvz sonatype-clm-server-1.12.0-bundle.tar.gz
x sonatype-clm-server-1.12.0.jar
x demo.sh
x config.yml
x eula.html
x demo.bat
x README.txt

The documentation uses specific blocks for notes, tips and important images:

[Note]

You can download Java from the Oracle website.

[Tip]

The CLM server should be set up to run as a service.

[Important]

CLM server requires Java 7.

In addition there are blocks for warnings and cautioning alerts:

[Warning]

Importing a policy will erase existing policies.

[Caution]

Upgrading components might require you to refactor your codebase.

Application screenshots and other images are typically included as numbered figures and referenced from the flowing text.