.\" Licensed to the Apache Software Foundation (ASF) under one .\" .\" or more contributor license agreements. See the NOTICE file .\" .\" distributed with this work for additional information .\" .\" regarding copyright ownership. The ASF licenses this file .\" .\" to you under the Apache License, Version 2.0 (the .\" .\" "License"); you may not use this file except in compliance .\" .\" with the License. You may obtain a copy of the License at .\" .\" .\" .\" http://www.apache.org/licenses/LICENSE-2.0 .\" .\" .\" .\" Unless required by applicable law or agreed to in writing, software .\" .\" distributed under the License is distributed on an "AS IS" BASIS, .\" .\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" .\" See the License for the specific language governing permissions and .\" .\" limitations under the License. .\" .TH "" 1 .SH NAME \- .SH SYNOPSIS .B .SH DESCRIPTION .SH OPTIONS .TP .B \- .TP .B \- .TP .B .SH "SEE ALSO" .SH BUGS .SH Reference http://www.cs.hmc.edu/tech_docs/qref/writing_man_pages.html Review comments on man pages ----------------------------- 1. No extra blank lines specified on any section. 2. Formatting of the synopsis section should be consistent with a. -help b. cli_detailed_command_list.txt c. Man page section. 3. Only options sections should be present. All operand section should be moved to options section. 3.a. Any missing Option section should be listed in the section. (Look in the spec and the example listed in the man page to fill up the option section.) 4. Execute the command and see if it is consistent. File a DDTS bug if the command does not work fine as the detailed_spec. 5. All example section should be aligned correctly. Use the following formats to achieve this option. a. Change All .TP command to .PP (For paragraphs.) b. For example use .PP followed by .fi 6. Prompt to be replaced to traffic_shell> 7. All commands should return either +OK or -ERROR after execution.