summaryrefslogtreecommitdiff
path: root/autoopts/test/doc.test
blob: d0c2989152c461b8ce0350492e0c6e80f5d0c716 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
#! /bin/sh
#  -*- Mode: Shell-script -*-
#
# doc.test      ---  test doc templates
#
# Time-stamp:        "2012-08-11 08:54:27 bkorb"
# Author:            Bruce Korb <bkorb@gnu.org>
#
##  This file is part of AutoOpts, a companion to AutoGen.
##  AutoOpts is free software.
##  AutoOpts is Copyright (c) 1992-2012 by Bruce Korb - all rights reserved
##
##  AutoOpts is available under any one of two licenses.  The license
##  in use must be one of these two and the choice is under the control
##  of the user of the license.
##
##   The GNU Lesser General Public License, version 3 or later
##      See the files "COPYING.lgplv3" and "COPYING.gplv3"
##
##   The Modified Berkeley Software Distribution License
##      See the file "COPYING.mbsd"
##
##  These files have the following md5sums:
##
##  43b91e8ca915626ed3818ffb1b71248b pkg/libopts/COPYING.gplv3
##  06a1a2e4760c90ea5e1dad8dfaac4d39 pkg/libopts/COPYING.lgplv3
##  66a5cedaf62c4b2637025f049f9b826f pkg/libopts/COPYING.mbsd

. ./defs

test_src=${srcdir}/${testname}.test

# # # # # # # # # # DEFINITIONS FILE # # # # # # # # #
echo make defs from test file
sed "1,/^##* *BEGIN-DEFS/d
     /^prog-name/s/=.*/= ${testname};/
     \\@^// *END-DEFS@q" \
    ${test_src} > ${testname}.def

# # # # # # # # # # TEXI DOC CHECK # # # # # # # # #
${AGexe} ${agl_opts} -Tagtexi-cmd ${testname}.def
test -f invoke-${testname}.menu -a -f invoke-${testname}.texi || \
    failure "invoke-${testname}.{menu,texi} not built"
sed '/^@ignore/,/^@end ignore/d' \
    invoke-${testname}.texi > ${testname}-res.texi
rm -f invoke-${testname}.menu invoke-${testname}.texi

sed "1,/^##* *BEGIN-TEXI/d
    /^@ignore/,/^@end ignore/d
    /^## END-TEXI/{;s/.*//;q;}" \
    ${test_src} > ${testname}-base.texi

outfiles="${testname}-res.texi ${testname}-base.texi"
cmp -s ${outfiles} || \
    failure "Differences: ${outfiles}${nl}`diff ${outfiles}`"

# # # # # # # # # # MAN DOC CHECK # # # # # # # # #
${AGexe} ${agl_opts} -Tagman-cmd ${testname}.def
test -f ${testname}.1 || \
    failure "${testname}.1 not built"

{
    sed '/^\.\\"/d;/^\.TH/s/ *".*//' ${testname}.1
    rm -f ${testname}.1
    echo
} > ${testname}-res.1

sed "1,/^##* *BEGIN-MAN/d
    /^## END-MAN/{;s/.*//;q;}" ${test_src} > ${testname}-base.1

outfiles="${testname}-base.1 ${testname}-res.1"
cmp -s ${outfiles} || \
    failure "Differences: ${outfiles}${nl}`diff ${outfiles}`"

# # # # # # # # # # MDOC DOC CHECK # # # # # # # # #
${AGexe} ${agl_opts} -Tagmdoc-cmd ${testname}.def
test -f ${testname}.1 || \
    failure "${testname}.1 not built"

{
    ${EGREP} -v '^\.(Dd |Os |\\")' ${testname}.1
    echo
} > ${testname}-mdoc-res.1

sed "1,/^##* *BEGIN-MDOC/d
    /^## END-MDOC/{;s/.*//;q;}" ${test_src} > ${testname}-mdoc-base.1

outfiles="${testname}-mdoc-base.1 ${testname}-mdoc-res.1"
cmp -s ${outfiles} || \
    failure "Differences: ${outfiles}${nl}`diff ${outfiles}`"

# # # # # # # # # # POT CHECK # # # # # # # # #
${AGexe} ${agl_opts} -Tdef2pot ${testname}.def
test -s ${testname}.pot || \
    failure "${testname}.pot not built"

{
    sed -e '/^# *Copyright/s/).*/)/' \
        -e '/^$/d' \
        -e 's/>, 20[0-9][0-9]\./>./' \
        -e '/POT-Creation-Date:/s/ 2[0-9].*/\\n"/' \
        ${testname}.pot
    echo
} > ${testname}-res.pot

sed "1,/^##* *BEGIN-POT/d
    /^$/d
    /^## END-POT/{;s/.*//;q;}" ${test_src} > ${testname}-base.pot

outfiles="${testname}-base.pot ${testname}-res.pot"
cmp -s ${outfiles} || \
    failure "Differences: ${outfiles}${nl}`diff ${outfiles}`"

# # # # # # # # # # # FINISH # # # # # # # # # # #

cleanup

exit 0

# # # # # # # # # # # OPTION DEFS

cat <<_End_Of_Definitions_
## BEGIN-DEFS
AutoGen Definitions options;
prog-name     = gnutls-cli;
prog-title    = "GnuTLS client";
prog-desc     = "Simple client program to set up a TLS connection.";
short-usage   = <<- _EOUsage_
	Usage: gnutls-cli [options] hostname
	gnutls-cli --help for usage instructions.
	_EOUsage_;
prog-group    = "GnuTLS";
detail        = <<- _EODetail_
	Simple client program to set up a TLS connection to some other computer.
	It sets up a TLS connection and forwards data from the standard input
	to the secured socket and vice versa.
	_EODetail_;

gnu-usage;
no-misuse-usage;
disable-save;
reorder-args;
no-xlate = opt;
argument = "[hostname]";
long-opts;

copyright  = {
    date   = "2000-2012";
    owner  = "Free Software Foundation";
    author = "Nikos Mavrogiannopoulos, Simon Josefsson and others; "
             "see /usr/share/doc/gnutls-bin/AUTHORS for a complete list.";
    eaddr  = "bug-gnutls@gnu.org";
    type   = gpl;
};
version       = "3.0.12";
help-value    = h;
more-help-value = M;

flag = {
    name      = debug;
    value     = d;
    arg-type  = number;
    arg-range = "0->9999";
    descrip   = "Enable @code{debugging}";
    doc = 'really enable debugging';
};

flag = {
    name      = mtu;
    arg-type  = number;
    arg-range = "0->17000";
    descrip   = "Set MTU for datagram TLS";
    doc   = "Really set MTU for datagram TLS";
};

flag = {
    name      = group-2;
    descrip   = "second group of options";
    documentation;
};

flag = {
    name      = crlf;
    descrip   = "Send CR LF instead of LF";
    doc   = "Really send CR LF instead of LF";
};

flag = {
    name      = x509fmtder;
    descrip   = "Use DER format for certificates to read from";
    doc   = "Really use DER format for certificates to read from";
};

flag = {
    name      = group-3;
    descrip   = "third group of options";
    documentation;
};

flag = {
    name      = recordsize;
    arg-type  = number;
    arg-range = "0->4096";
    descrip   = "The maximum record size to advertize";
    doc   = "Really the maximum record size to advertize";
};

flag = {
    name      = priority;
    arg-type  = string;
    descrip   = "Priorities string";
    doc       = <<- _EODoc_
	TLS algorithms and protocols to enable. You can
	use predefined sets of ciphersuites such as PERFORMANCE,
	NORMAL, SECURE128, SECURE256.

	Check the GnuTLS manual on section ``Priority strings'' for more
	information on allowed keywords
	_EODoc_;
};
	

doc-section = {
  ds-type   = 'SEE ALSO';
  ds-format = texi;
  omit-texi;
  ds-text   = 'gnutls-cli-debug(1), gnutls-serv(1)';
};

doc-section = {
  ds-type   = EXAMPLES;
  ds-format = texi;
  ds-text   = <<- _EOT_
	To connect to a server using PSK authentication, you need to enable
	the choice of PSK by using a cipher priority parameter such as in the
	example below.
	@example
	$ ./gnutls-cli -p 5556 localhost --pskusername psk_identity \\
	    --pskkey 88f3824b3e5659f52d00e959bacab954b6540344 \\
	    --priority NORMAL:-KX-ALL:+ECDHE-PSK:+DHE-PSK:+PSK
	Resolving 'localhost'...
	Connecting to '127.0.0.1:5556'...
	- PSK authentication.
	- Version: TLS1.1
	- Key Exchange: PSK
	- Cipher: AES-128-CBC
	- MAC: SHA1
	- Compression: NULL
	- Handshake was completed
	    
	- Simple Client Mode:
	@end example
	By keeping the --pskusername parameter and removing the --pskkey
	parameter, it will query only for the password during the handshake.
	
	To list the ciphersuites in a priority string:
	@example
	$ ./gnutls-cli --priority SECURE192 -l
	Cipher suites for SECURE192
	TLS_ECDHE_ECDSA_AES_256_CBC_SHA384  0xc0, 0x24	TLS1.2
	TLS_ECDHE_ECDSA_AES_256_GCM_SHA384  0xc0, 0x2e	TLS1.2
	TLS_ECDHE_RSA_AES_256_GCM_SHA384    0xc0, 0x30	TLS1.2
	TLS_DHE_RSA_AES_256_CBC_SHA256      0x00, 0x6b	TLS1.2
	TLS_DHE_DSS_AES_256_CBC_SHA256      0x00, 0x6a	TLS1.2
	TLS_RSA_AES_256_CBC_SHA256          0x00, 0x3d	TLS1.2
	@end example
	_EOT_;
};
// END-DEFS
_End_Of_Definitions_

# # # # # # # # # # # TEXI TEXT

cat <<_End_Of_TexInfo_
## BEGIN-TEXI
@node doc Invocation
@section Invoking doc
@pindex doc
@cindex GnuTLS client
Simple client program to set up a TLS connection to some other computer.
It sets up a TLS connection and forwards data from the standard input
to the secured socket and vice versa.

This section was generated by @strong{AutoGen},
using the @code{agtexi-cmd} template and the option descriptions for the @code{doc} program.
This software is released under the GNU General Public License, version 3 or later.

@menu
* doc usage::                  doc help/usage (@option{--help})
* doc base-options::           Base options
* doc group-2::                group-2 options
* doc group-3::                group-3 options
* doc exit status::            exit status
* doc Examples::               Examples
@end menu

@node doc usage
@subsection doc help/usage (@option{--help})
@cindex doc help

This is the automatically generated usage text for doc.

The text printed is the same whether selected with the @code{help} option
(@option{--help}) or the @code{more-help} option (@option{--more-help}).  @code{more-help} will print
the usage text by passing it through a pager program.
@code{more-help} is disabled on platforms without a working
@code{fork(2)} function.  The @code{PAGER} environment variable is
used to select the program, defaulting to @file{more}.  Both will exit
with a status code of 0.

@exampleindent 0
@example
doc is unavailable - no --help
@end example
@exampleindent 4

@node doc 
@subsection Base options
@subsubheading debug option (-d).
@anchor{doc debug}
@cindex doc-debug

This is the ``enable @code{debugging}'' option.
This option takes an argument number.
really enable debugging
@subsubheading mtu option.
@anchor{doc mtu}
@cindex doc-mtu

This is the ``set mtu for datagram tls'' option.
This option takes an argument number.
Really set MTU for datagram TLS
@node doc group-2
@subsection group-2 options
second group of options.
@subsubheading crlf option.
@anchor{doc crlf}
@cindex doc-crlf

This is the ``send cr lf instead of lf'' option.
Really send CR LF instead of LF
@subsubheading x509fmtder option.
@anchor{doc x509fmtder}
@cindex doc-x509fmtder

This is the ``use der format for certificates to read from'' option.
Really use DER format for certificates to read from
@node doc group-3
@subsection group-3 options
third group of options.
@subsubheading recordsize option.
@anchor{doc recordsize}
@cindex doc-recordsize

This is the ``the maximum record size to advertize'' option.
This option takes an argument number.
Really the maximum record size to advertize
@subsubheading priority option.
@anchor{doc priority}
@cindex doc-priority

This is the ``priorities string'' option.
This option takes an argument string.
TLS algorithms and protocols to enable. You can
use predefined sets of ciphersuites such as PERFORMANCE,
NORMAL, SECURE128, SECURE256.

Check the GnuTLS manual on section ``Priority strings'' for more
information on allowed keywords
@node doc exit status
@subsection doc exit status

One of the following exit values will be returned:
@table @samp
@item 0 (EXIT_SUCCESS)
Successful program execution.
@item 1 (EXIT_FAILURE)
The operation failed or the command syntax was not valid.
@end table
@node doc Examples
@subsection doc Examples
To connect to a server using PSK authentication, you need to enable
the choice of PSK by using a cipher priority parameter such as in the
example below.
@example
$ ./gnutls-cli -p 5556 localhost --pskusername psk_identity \\
    --pskkey 88f3824b3e5659f52d00e959bacab954b6540344 \\
    --priority NORMAL:-KX-ALL:+ECDHE-PSK:+DHE-PSK:+PSK
Resolving 'localhost'...
Connecting to '127.0.0.1:5556'...
- PSK authentication.
- Version: TLS1.1
- Key Exchange: PSK
- Cipher: AES-128-CBC
- MAC: SHA1
- Compression: NULL
- Handshake was completed
    
- Simple Client Mode:
@end example
By keeping the --pskusername parameter and removing the --pskkey
parameter, it will query only for the password during the handshake.

To list the ciphersuites in a priority string:
@example
$ ./gnutls-cli --priority SECURE192 -l
Cipher suites for SECURE192
TLS_ECDHE_ECDSA_AES_256_CBC_SHA384  0xc0, 0x24	TLS1.2
TLS_ECDHE_ECDSA_AES_256_GCM_SHA384  0xc0, 0x2e	TLS1.2
TLS_ECDHE_RSA_AES_256_GCM_SHA384    0xc0, 0x30	TLS1.2
TLS_DHE_RSA_AES_256_CBC_SHA256      0x00, 0x6b	TLS1.2
TLS_DHE_DSS_AES_256_CBC_SHA256      0x00, 0x6a	TLS1.2
TLS_RSA_AES_256_CBC_SHA256          0x00, 0x3d	TLS1.2
@end example
## END-TEXI
_End_Of_TexInfo_

# # # # # # # # # # # MAN PAGE

cat <<_End_Of_ManPage_
## BEGIN-MAN
.TH doc 1
.SH NAME
doc \- GnuTLS client
.SH SYNOPSIS
.B doc
.RB [ \-\fIflag\fP " [\fIvalue\fP]]... [" \-\-\fIopt\-name\fP " [[=| ]\fIvalue\fP]]..." [hostname]
.PP
Operands and options may be intermixed.  They will be reordered.
.SH "DESCRIPTION"
Simple client program to set up a TLS connection to some other computer.
It sets up a TLS connection and forwards data from the standard input
to the secured socket and vice versa.
.SH "OPTIONS"
.TP
.BR \-d " \fInumber\fP, " \-\-debug "=" \fInumber\fP
Enable \fBdebugging\fP.
This option takes an integer number as its argument.
The value of \fInumber\fP is constrained to being:
.in +4
.nf
.na
in the range  0 through 9999
.fi
.in -4
.sp
really enable debugging
.TP
.BR \-\-mtu "=\fInumber\fP"
Set MTU for datagram TLS.
This option takes an integer number as its argument.
The value of \fInumber\fP is constrained to being:
.in +4
.nf
.na
in the range  0 through 17000
.fi
.in -4
.sp
Really set MTU for datagram TLS
.SS "second group of options"
.TP
.BR \-\-crlf
Send CR LF instead of LF.
.sp
Really send CR LF instead of LF
.TP
.BR \-\-x509fmtder
Use DER format for certificates to read from.
.sp
Really use DER format for certificates to read from
.SS "third group of options"
.TP
.BR \-\-recordsize "=\fInumber\fP"
The maximum record size to advertize.
This option takes an integer number as its argument.
The value of \fInumber\fP is constrained to being:
.in +4
.nf
.na
in the range  0 through 4096
.fi
.in -4
.sp
Really the maximum record size to advertize
.TP
.BR \-\-priority "=\fIstring\fP"
Priorities string.
.sp
TLS algorithms and protocols to enable. You can
use predefined sets of ciphersuites such as PERFORMANCE,
NORMAL, SECURE128, SECURE256.
Check the GnuTLS manual on section \(lqPriority strings\(rq for more
information on allowed keywords
.TP
.BR \-h , " \-\-help"
Display usage information and exit.
.TP
.BR \-M , " \-\-more-help"
Pass the extended usage information through a pager.
.TP
.BR \-v " [{\fIv|c|n\fP}]," " \-\-version" "[=\fI{v|c|n}\fP]"
Output version of program and exit.  The default mode is `v', a simple
version.  The `c' mode will print copyright information and `n' will
print the full copyright notice.
.SH EXAMPLES
To connect to a server using PSK authentication, you need to enable
the choice of PSK by using a cipher priority parameter such as in the
example below.
.br
.in +4
.nf
$ ./gnutls\-cli \-p 5556 localhost \-\-pskusername psk_identity \\
    \-\-pskkey 88f3824b3e5659f52d00e959bacab954b6540344 \\
    \-\-priority NORMAL:\-KX\-ALL:+ECDHE\-PSK:+DHE\-PSK:+PSK
Resolving 'localhost'...
Connecting to '127.0.0.1:5556'...
- PSK authentication.
- Version: TLS1.1
- Key Exchange: PSK
- Cipher: AES\-128\-CBC
- MAC: SHA1
- Compression: NULL
- Handshake was completed
- Simple Client Mode:
.in -4
.fi
By keeping the \-\-pskusername parameter and removing the \-\-pskkey
parameter, it will query only for the password during the handshake.
.sp
To list the ciphersuites in a priority string:
.br
.in +4
.nf
$ ./gnutls\-cli \-\-priority SECURE192 \-l
Cipher suites for SECURE192
TLS_ECDHE_ECDSA_AES_256_CBC_SHA384  0xc0, 0x24	TLS1.2
TLS_ECDHE_ECDSA_AES_256_GCM_SHA384  0xc0, 0x2e	TLS1.2
TLS_ECDHE_RSA_AES_256_GCM_SHA384    0xc0, 0x30	TLS1.2
TLS_DHE_RSA_AES_256_CBC_SHA256      0x00, 0x6b	TLS1.2
TLS_DHE_DSS_AES_256_CBC_SHA256      0x00, 0x6a	TLS1.2
TLS_RSA_AES_256_CBC_SHA256          0x00, 0x3d	TLS1.2
.in -4
.fi
.SH "EXIT STATUS"
One of the following exit values will be returned:
.TP
.BR 0 " (EXIT_SUCCESS)"
Successful program execution.
.TP
.BR 1 " (EXIT_FAILURE)"
The operation failed or the command syntax was not valid.
.SH "SEE ALSO"
gnutls\-cli\-debug(1), gnutls\-serv(1)
.SH "AUTHORS"
Nikos Mavrogiannopoulos, Simon Josefsson and others; see /usr/share/doc/gnutls-bin/AUTHORS for a complete list.
.SH "COPYRIGHT"
Copyright (C) 2000-2012 Free Software Foundation all rights reserved.
This program is released under the terms of the GNU General Public License, version 3 or later.
.SH "BUGS"
Please send bug reports to: bug-gnutls@gnu.org
.SH "NOTES"
This manual page was \fIAutoGen\fP-erated from the \fBdoc\fP
option definitions.
## END-MAN
_End_Of_ManPage_

# # # # # # # # # # # MAN PAGE

cat <<_End_Of_MdocPage_
## BEGIN-MDOC
.Dt DOC 1 User Commands
.Sh NAME
.Nm doc
.Nd GnuTLS client
.Sh SYNOPSIS
.Nm
.Op Fl flags
.Op Fl flag Ar value
.Op Fl \-option-name Ar value
[hostname]
.Pp
Operands and options may be intermixed.  They will be reordered.
.Pp
.Sh "DESCRIPTION"
Simple client program to set up a TLS connection to some other computer.
It sets up a TLS connection and forwards data from the standard input
to the secured socket and vice versa.
.Sh "OPTIONS"
.Bl -tag
.It  \-d " \fInumber\fP, " \-\-debug "=" \fInumber\fP
Enable \fBdebugging\fP.
This option takes an integer number as its argument.
The value of \fInumber\fP is constrained to being:
.in +4
.nf
.na
in the range  0 through 9999
.fi
.in -4
.sp
really enable debugging
.It  \-\-mtu "=\fInumber\fP"
Set MTU for datagram TLS.
This option takes an integer number as its argument.
The value of \fInumber\fP is constrained to being:
.in +4
.nf
.na
in the range  0 through 17000
.fi
.in -4
.sp
Really set MTU for datagram TLS
.Ss "second group of options"
.It  \-\-crlf
Send CR LF instead of LF.
.sp
Really send CR LF instead of LF
.It  \-\-x509fmtder
Use DER format for certificates to read from.
.sp
Really use DER format for certificates to read from
.Ss "third group of options"
.It  \-\-recordsize "=\fInumber\fP"
The maximum record size to advertize.
This option takes an integer number as its argument.
The value of \fInumber\fP is constrained to being:
.in +4
.nf
.na
in the range  0 through 4096
.fi
.in -4
.sp
Really the maximum record size to advertize
.It  \-\-priority "=\fIstring\fP"
Priorities string.
.sp
TLS algorithms and protocols to enable. You can
use predefined sets of ciphersuites such as PERFORMANCE,
NORMAL, SECURE128, SECURE256.
.sp
Check the GnuTLS manual on section \(lqPriority strings\(rq for more
information on allowed keywords
.It \-h , " \-\-help"
Display usage information and exit.
.It \-M , " \-\-more-help"
Pass the extended usage information through a pager.
.It \-v " [{\fIv|c|n\fP}]," " \-\-version" "[=\fI{v|c|n}\fP]"
Output version of program and exit.  The default mode is `v', a simple
version.  The `c' mode will print copyright information and `n' will
print the full copyright notice.
.El
.Sh EXAMPLES
To connect to a server using PSK authentication, you need to enable
the choice of PSK by using a cipher priority parameter such as in the
example below.
.Bd -literal -offset indent
$ ./gnutls\-cli \-p 5556 localhost \-\-pskusername psk_identity \\
    \-\-pskkey 88f3824b3e5659f52d00e959bacab954b6540344 \\
    \-\-priority NORMAL:\-KX\-ALL:+ECDHE\-PSK:+DHE\-PSK:+PSK
Resolving 'localhost'...
Connecting to '127.0.0.1:5556'...
- PSK authentication.
- Version: TLS1.1
- Key Exchange: PSK
- Cipher: AES\-128\-CBC
- MAC: SHA1
- Compression: NULL
- Handshake was completed
- Simple Client Mode:
.Ed
By keeping the \-\-pskusername parameter and removing the \-\-pskkey
parameter, it will query only for the password during the handshake.
.sp
To list the ciphersuites in a priority string:
.Bd -literal -offset indent
$ ./gnutls\-cli \-\-priority SECURE192 \-l
Cipher suites for SECURE192
TLS_ECDHE_ECDSA_AES_256_CBC_SHA384  0xc0, 0x24	TLS1.2
TLS_ECDHE_ECDSA_AES_256_GCM_SHA384  0xc0, 0x2e	TLS1.2
TLS_ECDHE_RSA_AES_256_GCM_SHA384    0xc0, 0x30	TLS1.2
TLS_DHE_RSA_AES_256_CBC_SHA256      0x00, 0x6b	TLS1.2
TLS_DHE_DSS_AES_256_CBC_SHA256      0x00, 0x6a	TLS1.2
TLS_RSA_AES_256_CBC_SHA256          0x00, 0x3d	TLS1.2
.Ed
.Sh "EXIT STATUS"
One of the following exit values will be returned:
.Bl -tag
.It 0 " (EXIT_SUCCESS)"
Successful program execution.
.It 1 " (EXIT_FAILURE)"
The operation failed or the command syntax was not valid.
.El
.Sh "SEE ALSO"
gnutls\-cli\-debug(1), gnutls\-serv(1)
.Sh "AUTHORS"
Nikos Mavrogiannopoulos, Simon Josefsson and others; see /usr/share/doc/gnutls-bin/AUTHORS for a complete list.
.Sh "COPYRIGHT"
Copyright (C) 2000-2012 Free Software Foundation all rights reserved.
This program is released under the terms of the GNU General Public License, version 3 or later.
.Sh "BUGS"
Please send bug reports to: bug-gnutls@gnu.org
.Sh "NOTES"
This manual page was \fIAutoGen\fP-erated from the \fBdoc\fP
option definitions.
## END-MDOC
_End_Of_MdocPage_

# # # # # # # # # # # POT PAGE

cat <<_End_Of_PotPage_
## BEGIN-POT
# localization template (.pot) for doc.def of doc,
# this file is used to generate localized manual for doc.
# Copyright (C)
# This file is distributed under the terms of the
# the GNU General Public License, version 3 or later
# The program owners may be reached via:
#    Free Software Foundation <bug-gnutls@gnu.org>.
#
#, fuzzy
msgid   ""
msgstr  ""
"Project-Id-Version: doc 3.0.12\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date:\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"Language: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=CHARSET\n"
"Content-Transfer-Encoding: 8bit\n"

#: doc.def:3
msgid "GnuTLS client"
msgstr ""

#: doc.def:41
msgid "Enable debugging"
msgstr ""

#: doc.def:42
msgid "really enable debugging"
msgstr ""

#: doc.def:49
msgid "Set MTU for datagram TLS"
msgstr ""

#: doc.def:50
msgid "Really set MTU for datagram TLS"
msgstr ""

#: doc.def:55
msgid "second group of options"
msgstr ""

#: doc.def:61
msgid "Send CR LF instead of LF"
msgstr ""

#: doc.def:62
msgid "Really send CR LF instead of LF"
msgstr ""

#: doc.def:67
msgid "Use DER format for certificates to read from"
msgstr ""

#: doc.def:68
msgid "Really use DER format for certificates to read from"
msgstr ""

#: doc.def:73
msgid "third group of options"
msgstr ""

#: doc.def:81
msgid "The maximum record size to advertize"
msgstr ""

#: doc.def:82
msgid "Really the maximum record size to advertize"
msgstr ""

#: doc.def:88
msgid "Priorities string"
msgstr ""

#: doc.def:90
msgid "TLS algorithms and protocols to enable.  You can use predefined sets of\n"
       "ciphersuites such as PERFORMANCE, NORMAL, SECURE128, SECURE256.\n\n"
       "Check the GnuTLS manual on section ``Priority strings'' for more\n"
       "information on allowed keywords"
msgstr ""

#: doc.def:104
msgid "gnutls-cli-debug(1), gnutls-serv(1)"
msgstr ""

#: doc.def:111
msgid "To connect to a server using PSK authentication, you need to enable the\n"
       "choice of PSK by using a cipher priority parameter such as in the\n"
       "example below.  @example $ ./gnutls-cli -p 5556 localhost --pskusername\n"
       "psk_identity \\\\ --pskkey 88f3824b3e5659f52d00e959bacab954b6540344 \\\\\n"
       "--priority NORMAL:-KX-ALL:+ECDHE-PSK:+DHE-PSK:+PSK Resolving\n"
       "'localhost'...  Connecting to '127.0.0.1:5556'...  - PSK authentication.\n"
       "- Version: TLS1.1 - Key Exchange: PSK - Cipher: AES-128-CBC - MAC: SHA1\n"
       "- Compression: NULL - Handshake was completed\n\n"
       "- Simple Client Mode: @end example By keeping the --pskusername\n"
       "parameter and removing the --pskkey parameter, it will query only for\n"
       "the password during the handshake.\n\n"
       "To list the ciphersuites in a priority string: @example $ ./gnutls-cli\n"
       "--priority SECURE192 -l Cipher suites for SECURE192\n"
       "TLS_ECDHE_ECDSA_AES_256_CBC_SHA384 0xc0, 0x24 TLS1.2\n"
       "TLS_ECDHE_ECDSA_AES_256_GCM_SHA384 0xc0, 0x2e TLS1.2\n"
       "TLS_ECDHE_RSA_AES_256_GCM_SHA384 0xc0, 0x30 TLS1.2\n"
       "TLS_DHE_RSA_AES_256_CBC_SHA256 0x00, 0x6b TLS1.2\n"
       "TLS_DHE_DSS_AES_256_CBC_SHA256 0x00, 0x6a TLS1.2\n"
       "TLS_RSA_AES_256_CBC_SHA256 0x00, 0x3d TLS1.2 @end example"
msgstr ""

#: doc.def:11
msgid "Simple client program to set up a TLS connection to some other computer.\n"
       "It sets up a TLS connection and forwards data from the standard input to\n"
       "the secured socket and vice versa."
msgstr ""

#: 
msgid "This program is released under the terms of the GNU General Public License, version 3 or later."
msgstr ""

#: doc.def:21
msgid "[hostname]"
msgstr ""
## END-POT
_End_Of_PotPage_

## Local Variables:
## mode: shell-script
## indent-tabs-mode: nil
## sh-indentation: 2
## End:

# end of doc.test