Browse Source

Improve documentation.

Georgi Chorbadzhiyski 9 years ago
parent
commit
9c2510d566
2 changed files with 19 additions and 3 deletions
  1. 5
    0
      README
  2. 14
    3
      videohubctrl.1

+ 5
- 0
README View File

128
                 --vo-input 5 12 \
128
                 --vo-input 5 12 \
129
                 --vo-lock 5
129
                 --vo-lock 5
130
 
130
 
131
+ # This fails. It tries to use name that is not previously configured.
132
+
133
+   videohubctrl -h sdi --vo-name 1 "Test output" \\
134
+                       --vo-name "Test output" "Other name"
135
+
131
 
136
 
132
 Example output
137
 Example output
133
 ==============
138
 ==============

+ 14
- 3
videohubctrl.1 View File

71
 
71
 
72
 The port status field (s) have the same format as input ports (described
72
 The port status field (s) have the same format as input ports (described
73
 in \fB\-\-list\-vinputs\fR option).
73
 in \fB\-\-list\-vinputs\fR option).
74
-.SH VIDEO INPUT/OUTPUT CONFIGURATION
74
+.SH CONFIGURATION COMMANDS
75
+.PP
76
+Everywhere where port needs to be set, you can use the port number or the
77
+port name. You can use only port names that were already configured in
78
+previous session. Trying to set a name and then reference it in the next
79
+command will fail. Using port numbers always works.
80
+.SH VIDEO INPUTS CONFIGURATION
75
 .PP
81
 .PP
76
-Everywhere where port number is accepted, you can use the port
77
-number or the port name.
78
 .TP
82
 .TP
79
 \fB\-\-vi\-name\fR <in_X> <name>
83
 \fB\-\-vi\-name\fR <in_X> <name>
80
 Set video input port X name.
84
 Set video input port X name.
85
+.SH VIDEO OUTPUTS CONFIGURATION
86
+.PP
81
 .TP
87
 .TP
82
 \fB\-\-vo\-name\fR <out_X> <name>
88
 \fB\-\-vo\-name\fR <out_X> <name>
83
 Set video output port X name.
89
 Set video output port X name.
153
                 --vo-name 5 "Encoder h264" \\
159
                 --vo-name 5 "Encoder h264" \\
154
                 --vo-input 5 12 \\
160
                 --vo-input 5 12 \\
155
                 --vo-lock 5
161
                 --vo-lock 5
162
+
163
+ # This fails. It tries to use name that is not previously configured.
164
+   videohubctrl -h sdi --vo-name 1 "Test output" \\
165
+                       --vo-name "Test output" "Other name"
166
+
156
 .fi
167
 .fi
157
 .SH SEE ALSO
168
 .SH SEE ALSO
158
 See the README file for more information. If you have questions,
169
 See the README file for more information. If you have questions,

Loading…
Cancel
Save