TT#156156 Fix and unify man pages

- Add missing option values.
- Describe repeatable options.
- Use the same format for EXIT STATUS.
- Add missing trailing dots at end of sentences.
- Shorten man page titles.

Change-Id: Ia6c9536602677371eb6501ce21532734b39ec0f3
mr10.3
Guillem Jover 3 years ago
parent 4ecc7a19eb
commit 10c6282f43

@ -185,7 +185,7 @@ Password field
Email field
=item B<--reseller-id>
=item B<--reseller-id> I<id>
Reseller id the administartor belongs to (used in "add" and "update").
@ -235,7 +235,17 @@ Print a brief help message.
=head1 EXIT STATUS
Exit code 0 means everything is ok otherwise 1.
=over
=item B<0>
Command completed successfully.
=item B<1>
Command failed with errors.
=back
=head1 SEE ALSO

@ -92,7 +92,17 @@ Show additional debug information. Default false.
=head1 EXIT STATUS
Exit code 0 means everything is fine otherwise 1.
=over
=item B<0>
Command completed successfully.
=item B<1>
Command failed with errors.
=back
=head1 SEE ALSO

@ -131,7 +131,17 @@ Print a brief help message.
=head1 EXIT STATUS
Exit code 0 means everything is ok otherwise 1.
=over
=item B<0>
Command completed successfully.
=item B<1>
Command failed with errors.
=back
=head1 SEE ALSO

@ -146,7 +146,17 @@ Print a brief help message.
=head1 EXIT STATUS
Exit code 0 means everything is ok otherwise 1.
=over
=item B<0>
Command completed successfully.
=item B<1>
Command failed with errors.
=back
=head1 SEE ALSO

@ -143,7 +143,17 @@ Print a brief help message.
=head1 EXIT STATUS
Exit code 0 means everything is ok otherwise 1.
=over
=item B<0>
Command completed successfully.
=item B<1>
Command failed with errors.
=back
=head1 SEE ALSO

@ -189,7 +189,7 @@ A local number part of the subscriber's number.
=over 8
=item B<-s>, B<--admin>
=item B<-s>, B<--admin> I<0|1>
Set the administrative flag for the new subscriber.
Defaults to 0 (no).
@ -198,24 +198,24 @@ Defaults to 0 (no).
A display name part of the subscriber's number.
=item B<--aliases>
=item B<--aliases> I<aliases>
A list of alias numbers
Format: --aliases "cc=43 ac=1 sn=123" --aliases "cc=43 ac=1 sn=456"
Optional:
is_devid=1
devid_alias=Alice
A space separated list of alias numbers. The option can be specified multiple
times.
Format: --aliases "cc=43 ac=1 sn=123" --aliases "cc=43 ac=1 sn=456"
Optional:
is_devid=1
devid_alias=Alice
=item B<--pbx-pilot>
Set the "pbx pilot" flag for the new subscriber.
Set the "pbx pilot" flag to 1 for the new subscriber.
Defaults to 0 (no).
=item B<--pbx-extension>
=item B<--pbx-extension> I<number>
PBX extension number (only usable for PBX subscribers)
PBX extension number (only usable for PBX subscribers).
=item B<--verbose>
@ -229,7 +229,17 @@ Print a brief help message.
=head1 EXIT STATUS
Exit code 0 means everything is ok otherwise 1.
=over
=item B<0>
Command completed successfully.
=item B<1>
Command failed with errors.
=back
=head1 SEE ALSO

@ -233,7 +233,17 @@ Print a brief help message.
=head1 EXIT STATUS
Exit code 0 means everything is ok otherwise 1.
=over
=item B<0>
Command completed successfully.
=item B<1>
Command failed with errors.
=back
=head1 SEE ALSO

@ -148,7 +148,17 @@ Print a brief help message.
=head1 EXIT STATUS
Exit code 0 means everything is ok otherwise 1.
=over
=item B<0>
Command completed successfully.
=item B<1>
Command failed with errors.
=back
=head1 SEE ALSO

@ -277,7 +277,7 @@ __END__
=head1 NAME
ngcp-fraud-notifier - sends fraud notifications for customers that exceed the threshold
ngcp-fraud-notifier - send fraud notifications for customers exceeding thresholds
=head1 SYNOPSIS
@ -304,7 +304,17 @@ Print a brief help message.
=head1 EXIT STATUS
Exit code 0 means everything is ok otherwise 1.
=over
=item B<0>
Command completed successfully.
=item B<1>
Command failed with errors.
=back
=head1 SEE ALSO

@ -116,7 +116,17 @@ Print a brief help message.
=head1 EXIT STATUS
Exit code 0 means everything is ok, otherwise 1.
=over
=item B<0>
Command completed successfully.
=item B<1>
Command failed with errors.
=back
=head1 SEE ALSO

@ -101,7 +101,17 @@ Print a brief help message.
=head1 EXIT STATUS
Exit code 0 means everything is ok otherwise 1.
=over
=item B<0>
Command completed successfully.
=item B<1>
Command failed with errors.
=back
=head1 SEE ALSO

@ -121,7 +121,17 @@ Print a brief help message.
=head1 EXIT STATUS
Exit code 0 means everything is ok otherwise 1.
=over
=item B<0>
Command completed successfully.
=item B<1>
Command failed with errors.
=back
=head1 SEE ALSO

@ -128,7 +128,17 @@ Print a brief help message
=head1 EXIT STATUS
Exit code 0 means everything is ok otherwise 1.
=over
=item B<0>
Command completed successfully.
=item B<1>
Command failed with errors.
=back
=head1 SEE ALSO

Loading…
Cancel
Save