Browse Source

TT#124273 add missing manpages

* update generator to deal with manpages references to ngcp-*

Change-Id: Ibabf15e461d5aaac2099b5750f98ca21a59c09af
pull/1498/head
Victor Seva 4 years ago
committed by Víctor Seva
parent
commit
10060d36f8
8 changed files with 77 additions and 1 deletions
  1. +1
    -0
      debian/ngcp-rtpengine-daemon.manpages
  2. +16
    -0
      debian/ngcp-rtpengine-iptables-setup.1
  3. +1
    -0
      debian/ngcp-rtpengine-recording-daemon.manpages
  4. +16
    -0
      debian/ngcp-rtpengine-recording-nfs-setup.1
  5. +2
    -0
      debian/ngcp-rtpengine-utils.manpages
  6. +3
    -1
      pkg/deb/generator.sh
  7. +22
    -0
      utils/rtpengine-ctl.1
  8. +16
    -0
      utils/rtpengine-ng-client.1

+ 1
- 0
debian/ngcp-rtpengine-daemon.manpages View File

@ -1 +1,2 @@
daemon/rtpengine.8
debian/ngcp-rtpengine-iptables-setup.1

+ 16
- 0
debian/ngcp-rtpengine-iptables-setup.1 View File

@ -0,0 +1,16 @@
.TH man 1 "17 May 2022" "1.0" "ngcp-rtpengine-iptables-setup man page"
.SH NAME
ngcp\-rtpengine\-iptables\-setup \- manages iptables rules for ngcp\-rtpengine\-daemon service
.SH SYNOPSIS
ngcp\-rtpengine\-iptables\-setup [start|stop]
.SH DESCRIPTION
ngcp\-rtpengine\-iptables\-setup will enable or disable the iptables rules needed by rtpengine to properly work.
This program will be called by ngcp\-rtpengine\-daemon service.
.SH OPTIONS
ngcp\-rtpengine\-iptables\-setup has no options.
.SH SEE ALSO
rtpengine(8)
.SH BUGS
No known bugs.
.SH AUTHOR
Victor Seva (vseva@sipwise.com)

+ 1
- 0
debian/ngcp-rtpengine-recording-daemon.manpages View File

@ -1 +1,2 @@
debian/ngcp-rtpengine-recording-nfs-setup.1
recording-daemon/rtpengine-recording.8

+ 16
- 0
debian/ngcp-rtpengine-recording-nfs-setup.1 View File

@ -0,0 +1,16 @@
.TH man 1 "17 May 2022" "1.0" "ngcp-rtpengine-recording-nfs-setup man page"
.SH NAME
ngcp\-rtpengine\-recording\-nfs\-setup \- manages NFS mount for ngcp\-rtpengine\-recording\-daemon service
.SH SYNOPSIS
ngcp\-rtpengine\-recording\-nfs\-setup [start|stop]
.SH DESCRIPTION
ngcp\-rtpengine\-recording\-nfs\-setup will mount or unmount the NFS resource needed by ngcp\-rtpengine\-recording\-daemon to properly work.
This program will be called by ngcp\-rtpengine\-recording\-daemon service.
.SH OPTIONS
ngcp\-rtpengine\-recording\-nfs\-setup has no options.
.SH SEE ALSO
rtpengine\-recording(8)
.SH BUGS
No known bugs.
.SH AUTHOR
Victor Seva (vseva@sipwise.com)

+ 2
- 0
debian/ngcp-rtpengine-utils.manpages View File

@ -0,0 +1,2 @@
utils/rtpengine-ctl.1
utils/rtpengine-ng-client.1

+ 3
- 1
pkg/deb/generator.sh View File

@ -15,7 +15,9 @@ cp -ra backports debian
# rules
echo "- Remove ngcp- prefix"
find debian -maxdepth 1 -type f -exec sed -i -e 's/ngcp-rtpengine/rtpengine/g' {} \;
find debian -maxdepth 1 -type f -exec \
sed -i -e 's/ngcp-rtpengine/rtpengine/g' \
-e 's/ngcp\\-rtpengine/rtpengine/g' {} \;
## remove same file on links
while read -r file; do


+ 22
- 0
utils/rtpengine-ctl.1 View File

@ -0,0 +1,22 @@
.TH man 1 "17 May 2022" "1.0" "rtpengine-ctl man page"
.SH NAME
rtpengine\-ctl \- utility for sending commands to ngcp\-rtpengine\-daemon service
.SH SYNOPSIS
rtpengine\-ctl [ -h -config-file <file> -ip <ipaddress>[:<port>] -port <port> ] <command>
.SH DESCRIPTION
rtpengine\-ctl will send commands to the specified ngcp\-rtpengine\-daemon
.SH OPTIONS
.IP -h -help
Will print a full list of supported commands.
.IP -config-file
Path to rtpengine.conf file. It will use ip:port defined there to connect to the ngcp\-rtpengine\-daemon service.
.IP -ip
ipaddress or ipaddress:port to use to connect to the ngcp\-rtpengine\-daemon. Defaults to 127.0.0.1
.IP -port
port to use to connect to the ngcp\-rtpengine\-daemon. Defaults to 9900
.SH SEE ALSO
rtpengine(8)
.SH BUGS
No known bugs.
.SH AUTHOR
Victor Seva (vseva@sipwise.com)

+ 16
- 0
utils/rtpengine-ng-client.1 View File

@ -0,0 +1,16 @@
.TH man 1 "17 May 2022" "1.0" "rtpengine-ng-client man page"
.SH NAME
rtpengine\-ng\-client \- utility for sending client commands to ngcp\-rtpengine\-daemon service
.SH SYNOPSIS
rtpengine\-ng\-client <NG-OPTIONS>
.SH DESCRIPTION
rtpengine\-ng\-client will send NG commands to the specified ngcp\-rtpengine\-daemon service.
This util is mainly used to simulate a client in a development environment.
.SH OPTIONS
See the full list of NG parameters at README.
.SH SEE ALSO
rtpengine(8)
.SH BUGS
No known bugs.
.SH AUTHOR
Victor Seva (vseva@sipwise.com)

Loading…
Cancel
Save