Technical Documentation
How to Use the JUNOS Documentation
The JUNOS software documentation is divided into a number of books.
See the list of individual book titles and descriptions
How to Find Information about a Topic
If you know which book a topic is discussed in, you can use the following to find the information you are looking for:
If you do not know which book a topic is discussed in, locate the topic in the comprehensive index, then go to that book.
How to Find Information about a Statement or Command
To find information about a statement or command:
- Go to the Index of Statements and Commands, either in the comprehensive index or in the book.
- From the comprehensive index, go to the appropriate book.
- Go to the appropriate page.
Use the Comprehensive Index
- This book indexes all topics in the JUNOS configuration guides, the JUNOS command references, and the JUNOScript API guide. It contains two indexes:
- Complete index—Contains all index entries.
- Index of statements and commands—Contains only configuration statements and operational-mode and configuration-mode commands.
Each index entry includes the two-letter abbreviation for the book in which the entry can be found.
The comprehensive index is available in PDF format only.
- To use the comprehensive index:
- Locate the desired topic, statement, or command in the index.
-
Note the book or books in which that topic is discussed. Then do one of the following:
- To go to the page number indicated in the index, open the PDF version of the book and go to that page number. The page number is the number at the bottom of the text page, not the page number within the PDF file itself.
- To go to the topic in an HTML version of the book, open the HTML version in a browser window and use the book's indexes to locate the topic. Then click the topic to go to the section that discusses it. Because of the tools and processes we use to create the comprehensive index, clicking on an entry in the comprehensive index does not link you to the section that discusses the topic.
Use a Search Engine
Use a search engine if you know the specific name of the term, statement, or command.
- To use a search engine to locate a topic:
- In a PDF file, use the Find command.
- On www.juniper.net, use the Search facility. To search only the product documentation, click This Section. In Scope for search, select Technical Documentation.
Use the Indexes in a Book
- Each book has one or two indexes:
- Complete index (in all books)—Contains all index entries.
- Index of statements and commands (in most books)—Lists only configuration statements and operational-mode and configuration-mode commands. For statements, the entries refer to quick reference-style descriptions of the statements. These reference pages include links to the complete configuration and usage information.
- To locate the book indexes, see:
- PDF version of the entire book—The indexes are listed in the left sidebar.
- HTML (frames version)—Click Show Index to see the complete index. Click Index of Statements and Commands to see that index.
- HTML (no frames version)—Click Index or Index of Statements and Commands to see the desired index.
Use the Table of Contents
- Each book has one or two tables of contents:
- Abbreviated table of contents (in most books)—Lists part and chapter titles only. This format is useful for getting a quick overview of a book's organization and content and for locating a high-level topic.
- Complete table of contents (in all books)—Contains complete book contents. This format is useful for locating specific information in a book.
- To locate the tables of contents, see:
- PDF version of the entire book—The tables of contents are listed in the left sidebar.
- HTML (frames version)—Click Expand TOC to see complete contents and Collapse TOC to see abbreviated contents.
- HTML (no frames version)—Click Long Contents to see complete contents and Short Contents to see abbreviated contents.