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
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
|
includefile(include/header)
manpage(Bobcat)(7)(_CurYrs_)(libbobcat-dev__CurVers_)
(C++ Classes)
whenhtml(center(htmlcommand(<img src="bobcat.jpg">)))
manpagename(Bobcat)(Overview of classes in the Bobcat library)
manpagedescription()
The classes of the bf(Bobcat) library may be used after including
tt(bobcat/classname) in sources.
Generally, programs using the bf(Bobcat) library must be at least linked
against the bf(Bobcat) library. Refer to section bf(LINKING) for more
informatin about linking programs to required libraries.
All classes and other elements are defined in the tt(FBB) namespace. For some
classes em(manipulators) are available, which are defined in the tt(FBB)
namespace. An overview of all manipulators defined in the tt(FBB) namespace is
provided by tt(man -e bobcat manipulators).
Beyond this section the section bf(CATEGORIES) groups classes that
somehow belong together in various categories.
The following classes and functions are available:
bf(FBB::Align): Specifies tt(Table(Buf)) column and element
alignments.nl()
Manpage(align)
bf(FBB::Arg): Interfaces the command line arguments, allowing for
short- and long options. The class is implemented as a tt(Singleton).nl()
Manpage(arg)
bf(FBB::ArgConfig): Inherits from tt(Arg) and tt(ConfigFile) allowing for
options to be specified as command line options and/or configuration file
options. The class is implemented as a tt(Singleton).nl()
Manpage(argconfig)
bf(FBB::A2x): Ascii-to-x conversions of any type supporting extractions
from tt(i[string]stream) objects.
Manpage(a2x)
bf(FBB::BigInt): Wrapper class around the openssl BN_ functions for
unlimited integer precision arithmetic. nl()
Manpage(bigint)
bf(FBB::binary_search): A modification of the STL tt(binary_search)
algorithm returning the location of the searched value in a sorted series
of values. nl()
Manpage(binarysearch)
bf(FBB::BinOps): A series of function templates implementing binary
operators for classes that implement the matching binary assignment
operators themselves. nl()
Manpage(binops)
bf(FBB::BinOpsBase): A class template implementing binary
operators and compound assignment operators for classes that themselves
implement swap members and members implementing the basic binary operation
on objects of their class types themselves. nl()
Manpage(binopsbase)
bf(FBB::CerrExtractor): Executes child processes not expecting input but
maybe writing its standard error stream. nl()
Manpage(cerrextractor)
bf(FBB::CGI): a class implementing the facilities accessing the data made
available through the Common Gateway Interface.nl()
Manpage(cgi)
bf(FBB::Cidr): a class testing whether IP4 Internet addresses belong to
address ranges defined by Classless Inter-Domain Routing (CIDR) address
block specifications.nl()
Manpage(cidr)
bf(FBB::CinInserter): Executes child processes expecting input but not
producing standard output. nl()
Manpage(cininserter)
bf(FBB::ClientSocket): a socket for tcp-communication with a server.nl()
Manpage(clientsocket)
bf(FBB::CmdFinder): Command-function associations.nl()
Manpage(cmdfinder)
bf(FBB::CmdFinderBase): Base class for tt(CmdFinder).nl()
Manpage(cmdfinderbase)
bf(FBB::Config): Processing standard configuration files.nl()
Manpage(config)
bf(FBB::ConfigFile): Processing standard configuration files (deprecated,
use bf(Config)).nl()
Manpage(configfile)
bf(FBB::CoutExtractor): Executes child processes not expecting input but
maybe producing standard output. nl()
Manpage(coutextractor)
bf(FBB::CSVTable): Construct tables row-by-row.nl()
Manpage(csvtable)
bf(FBB::CSV4180): Objects of this class allow for easy handling of
comma-separated values (implements RFC 4180).nl()
Manpage(csv4180)
bf(FBB::DateTime): Manipulations with date and time values.nl()
Manpage(datetime)
bf(FBB::DiffieHellman): Computing shared keys using the Diffie-Hellman
algorithm.nl()
Manpage(diffiehellman)
bf(FBB::DigestBuf): Computing message digests.nl()
Manpage(digestbuf)
bf(FBB::ECDH): Computing shared keys using the elliptic curve based
Diffie-Hellman algorithm.nl()
Manpage(ecdh)
bf(FBB::Eoi): tt(std::streambuf) offering the tt(eoi) manipulator.nl()
Manpage(eoi)
bf(FBB::Eoi): tt(std::streambuf) offering the tt(eoi) manipulator.nl()
Manpage(eoi)
bf(FBB::EoiBuf): tt(std::streambuf) offering the tt(eoi) manipulator and a
configurable stream buffer.nl()
Manpage(eoibuf)
bf(FBB::Exception): objects of this class accept tt(ostream) insertions,
and are also tt(std::exception) objects.nl()
Manpage(exception)
bf(FBB::Exec): Executes child processes not expecting input and not
producing standard output. nl()
Manpage(exec)
bf(FBB::Field): class template retrieving and modifying position based
fields in numbers using configurable number systems. nl()
Manpage(field)
bf(FBB::Fork): Defines bf(fork)(2) as part of a Template Algorithm Design
Pattern. nl()
Manpage(fork)
bf(FBB::GetHostent): Obtains tt(hostent) struct from hostname or
-address. nl()
Manpage(gethostent)
bf(FBB::Glob): Obtain a list of files matching a certain pattern.nl()
Manpage(glob)
bf(FBB::HmacBuf): Computing HMAC message digests.nl()
Manpage(hmacbuf)
bf(FBB::Hostname): Derived from tt(Hostent), allows the initialization
from a tt(std::string), or from an tt(FBB::InetAddrress). nl()
Manpage(hostname)
bf(FBB::IBase64Stream): stream implementing base64 encoding and decoding,
using a tt(FBB::Base64Streambuf) stream buffer.nl()
Manpage(ibase64stream)
bf(FBB::IBase64Buf): tt(FBB::IFilterBuf) specialization
implementing base64 encoding and decoding.nl()
Manpage(ibase64buf)
bf(FBB::IFdStream): stream extracting information from a device whose
file descriptor is available. nl()
Manpage(ifdstream)
bf(FBB::IFdBuf): Input stream buffer initialized by a file
descriptor.nl()
Manpage(ifdbuf)
bf(FBB::IFilterBuf): tt(std::streambuf) specialization implementing
an tt(std::istream) filtering design pattern.nl()
Manpage(ifilterbuf)
bf(FBB::Indent): Class and manipulators performing text indentation. nl()
Manpage(indent)
bf(FBB::InetAddress): Base class (no public constructor) for objects
representing an internet address as used with sockets. Contains address
and portnumbers. nl()
Manpage(inetaddress)
bf(FBB::IOStream): class combining tt(std::istream) and tt(std::ostream)
features. nl()
Manpage(iostream)
bf(FBB::IOBuf): tt(std::streambuf) specialization allowing combined
input and output operations. nl()
Manpage(iobuf)
bf(FBB::ISharedStream): tt(std::istream) operations on shared memory.nl()
Manpage(isharedstream)
bf(FBB::IQuotedPrintableStream): stream implementing quoted printable
encoding and decoding, using a tt(FBB::IQuotedPrintableBuf) stream
buffer.nl()
Manpage(iquotedprintablestream)
bf(FBB::IQuotedPrintableBuf): tt(FBB::IFilterBuf)
specialization implementing quoted printable encoding and decoding.nl()
Manpage(iquotedprintablebuf)
bf(FBB::IRandStream): stream to extract random numbers from. nl()
Manpage(irandstream)
bf(FBB::ISymCryptStream): stream implementing symmetric encryption and
decryption, using a tt(FBB::ISymCryptStreambuf) stream buffer.nl()
Manpage(isymcryptstream)
bf(FBB::ISymCryptStreambuf): tt(FBB::IFilterBuf) specialization
implementing symmetric cryptography.nl()
Manpage(isymcryptstreambuf)
bf(FBB::Iterator): a class template creating a bidirectional iterator
returning values of a specified type.nl()
Manpage(iterator)
bf(FBB::Hash...): Various class templates implementing mapping containers
using hashing.nl()
Manpage(hash)
bf(FBB::Hostent): Wrapper around the tt(hostent) struct. nl()
Manpage(hostent)
bf(FBB::LDC): Large Digital Converter converts (large) values for various
radices. nl()
Manpage(ldc)
bf(FBB::level): Manipulator setting the log-level of tt(FBB::Log)
objects.nl()
Manpage(level)
bf(FBB::LinearMap): a class template container implementing a map using
a linear search algorithm.nl()
Manpage(linearmap)
bf(FBB::lm): Manipulator setting the left margin of tt(FBB::OFoldStream)
objects.nl()
Manpage(lm)
bf(FBB::LocalClientSocket): a Unix domain socket for
tcp-communication with a Unix domain (local) server.nl()
Manpage(localclientsocket)
bf(FBB::LocalServerSocket): defines a Unix domain socket to which
clients on the local host can connect.nl()
Manpage(localserversocket)
bf(FBB::LocalSocketBase): Base class for tt(LocalClientSocket) and
tt(LocalServerSocket).
nl()
Manpage(localsocketbase)
bf(FBB::Log): tt(std::ostream) handling log messages.nl()
Manpage(log)
bf(FBB::LogBuf): tt(std::streambuf) handling log messages.nl()
Manpage(logbuf)
bf(FBB::MailHeaders): extracts mail headers from SMTP-email.nl()
Manpage(mailheaders)
bf(FBB::Manipulators): manipulators defined in the namespace bf(FBB).nl()
Manpage(manipulators)
bf(FBB::Mbuf): tt(std::streambuf) specialization for inserting messages,
mainly used by tt(FBB::Mstream) objects. nl()
Manpage(mbuf)
bf(FBB::Milter): interfaces the sendmail mail filter facilities.nl()
Manpage(milter)
bf(FBB::mlm): Manipulator modifying the left margin of
tt(FBB::OFoldStream) objects.nl()
Manpage(mlm)
bf(FBB::Mstream): Inserts messages into streams. nl()
Manpage(mstream)
bf(FBB::MultiBuf): tt(std::streambuf) specializations performing
insertions to multiple tt(std::ostream) objects.nl()
Manpage(multibuf)
bf(FBB::OMutexStream): Mutex protected tt(std::ostream).nl()
Manpage(mxstream)
bf(FBB::OFdStream): stream inserting information into a device whose
file descriptor is available. nl()
Manpage(ofdstream)
bf(FBB::OFdBuf): Output stream buffer initialized by a file
descriptor.nl()
Manpage(ofdbuf)
bf(FBB::OFilterBuf): tt(std::streambuf) specialization implementing
an tt(std::ostream) filtering design pattern.nl()
Manpage(ofilterbuf)
bf(FBB::OFoldStream): tt(std::ostream) using an tt(OFoldBuf) as its
streambuf. nl()
Manpage(ofoldstream)
bf(FBB::OFoldBuf): tt(OFilterBuf) (tt(std::streambuf))
specialization folding text lines between left and right margins.nl()
Manpage(ofoldbuf)
bf(FBB::OHexBuf): tt(OHexBuf) (tt(std::streambuf))
specialization inserting characters into a stream by their hex values.nl()
Manpage(ohexbuf)
bf(FBB::OneKey): Single keystroke input, not requiring `Return'.nl()
Manpage(onekey)
bf(FBB::OSharedStream): tt(std::ostream) operations on shared memory.nl()
Manpage(osharedstream)
bf(FBB::OSymCryptStream): stream implementing symmetric encryption and
decryption, using a tt(FBB::OSymCryptStreambuf) stream buffer.nl()
Manpage(osymcryptstream)
bf(FBB::OSymCryptStreambuf): streambuf derived from tt(FBB::EoiBuf)
implementing symmetric cryptography.nl()
Manpage(osymcryptstreambuf)
bf(FBB::Pattern): Regular expression pattern matching.nl()
Manpage(pattern)
bf(FBB::Pipe): Defines a system level pipe. nl()
Manpage(pipe)
bf(FBB::PrimeFactors): Prime-number factorization of (BigInt) values.nl()
Manpage(primefactors)
bf(FBB::Process): Runs child processes, defining pipes between parents and
child processes. nl()
Manpage(process)
bf(FBB::PtrIter): Input iterator whose dereferenced value returns a
pointer rather than a reference to an element. Also offers: a tt(ptrIter)
function template. nl()
Manpage(ptriter)
bf(FBB::RandBuf): implements a tt(streambuf) generating random
numbers. nl()
Manpage(randbuf)
bf(FBB::RandomMt): class template generating random numbers. nl()
Manpage(randommt)
bf(FBB::Ranger): a class template creating ranges that are accepted by
range-based for-loops. Also offered: a tt(ranger) function template. nl()
Manpage(ranger)
bf(FBB::ReadLineBuf): implements a tt(streambuf) using the Gnu
tt(readline) library to allow editing an tt(std::istream)'s content. nl()
Manpage(readlinebuf)
bf(FBB::ReadLineHistory): provides access to the history of lines read
from a tt(ReadLineBuf). nl()
Manpage(readlinehistory)
bf(FBB::ReadLineStream): tt(std::istream) class using a tt(ReadLineBuf)
for its tt(std::streambuf). nl()
Manpage(readlinestream)
bf(FBB::Redirector): Defines system level file redirection. nl()
Manpage(redirector)
bf(FBB::repeat): Two short extensions of the STL
tt(for_each) generic algorithm. nl()
Manpage(repeat)
bf(FBB::Reverse): a class template creating a reverse iterator
returning values of a specified type.nl() Manpage(reverse)
bf(FBB::Selector): Offers timed delays and multiple file I/O. nl()
Manpage(selector)
bf(FBB::Semaphore): Dijkstra's (1962) Semaphore data type.nl()
Manpage(semaphore)
bf(FBB::ServerSocket): defines a socket to which clients can connect.nl()
Manpage(serversocket)
bf(FBB::SharedBlock): Shared memory data block info.nl()
Manpage(sharedblock)
bf(FBB::SharedCondition): Shared memory condition variable.nl()
Manpage(sharedcondition)
bf(FBB::SharedMemory): Shared memory structure.nl()
Manpage(sharedmemory)
bf(FBB::SharedMutex): Mutex for shared memory.nl()
Manpage(sharedmutex)
bf(FBB::SharedPos): Shared Memory offset controller.nl()
Manpage(sharedpos)
bf(FBB::SharedReadme): Background info about the implementation of
Bobcat's Shared Memory.nl()
Manpage(sharedreadme)
bf(FBB::SharedSegment): Shared memory data structure.nl()
Manpage(sharedsegment)
bf(FBB::SharedStream): I/O operations on shared memory.nl()
Manpage(sharedstream)
bf(FBB::SharedBuf): tt(std::streambuf) interfacing to shared
memory.nl()
Manpage(sharedbuf)
bf(FBB::Signal): Defines signals, allowing signal handlers to use object's
data members c.q. to call object's members functions. nl()
Manpage(signal)
bf(FBB::SocketBase): Base class for tt(ClientSocket) and tt(ServerSocket).
nl()
Manpage(socketbase)
bf(FBB::Stat): Determines file characteristics.nl()
Manpage(stat)
bf(FBB::StdExtractor): Executes child processes not expecting input but
maybe writing their standard output and error streams. nl()
Manpage(stdextractor)
bf(FBB::String): Offers extended tt(std::string) functionality.nl()
Manpage(string)
bf(FBB::StringLine): Offers tt(operator>>) extracting lines from
tt(std::istream) objects.nl()
Manpage(stringline)
bf(FBB::SyslogBuf): streambuf to
Buffer generating bf(syslog)(3) messages. nl()
Manpage(syslogbuf)
bf(FBB::SyslogStream): stream to
Output stream inserting bf(syslog)(3) messages. nl()
Manpage(syslogstream)
bf(FBB::fswap): templates implementing memory bytes based swap
functionality nl()
Manpage(fswap)
bf(FBB::Table): Display tables row- or column-wise.nl()
Manpage(CHAR(t)able)
bf(FBB::TableBuf): Display tables row- or column-wise.nl()
Manpage(CHAR(t)ablebuf)
bf(FBB::TableLines): Support class for the class tt(Table(Buf)).nl()
Manpage(tablelines)
bf(FBB::TableSupport): Support class for the class tt(Table(Buf)).nl()
Manpage(tablesupport)
bf(FBB::TempStream): Temporary fstream. nl()
Manpage(tempstream)
bf(FBB::Tty): Controls echoing of characters entered at the terminal.nl()
Manpage(tty)
bf(FBB::TypeTrait): Traits class template to determine various
characteristics of types.nl()
Manpage(typetrait)
bf(FBB::User): Determines the current user's parameters from
tt(/etc/passwd).nl()
Manpage(user)
bf(FBB::Xpointer): sets and retrieves the X-windows pointer.nl()
Manpage(xpointer)
bf(FBB::X2a): x-to-Ascii conversions of any type supporting insertions
into tt(o[string]stream) objects.nl()
Manpage(x2a)
COMMENT(
bf(FBB::sequence_includes()): Template function implementing a variant of
the bf(includes()) generic algorithm, not requiring sorted series.
(Manpage: bf(man -e bobcat sequenceincludes))
END COMMENT)
manpagesection(CATEGORIES)
This section groups classes that somehow belong together. The following
categories are offered:
itemization(
it() bf(COMMAND LINE INTERFACE AND CONFIGURATION FILES)
it() bf(CONVERSIONS)
it() bf(DATE AND TIME)
it() bf(ERRORS AND MESSAGE HANDLING)
it() bf(GENERIC ALGORITHM EXTENSIONS)
it() bf(INTERNET / NETWORKING)
it() bf(OPENSSL AND ENCRYPTION)
it() bf(PATTERN MATCHING)
it() bf(PROCESSES, SIGNALS, THREADS)
it() bf(STREAMS AND FILES)
it() bf(SHARED MEMORY)
it() bf(TABLES)
it() bf(VARIOUS TEMPLATES)
it() bf(VARIOUS OTHER CLASSES)
COMMENT( it() bf(DEPRECATED CLASSES))
)
itemization(
it() bf(COMMAND LINE INTERFACE AND CONFIGURATION FILES)
bf(FBB::Arg): Interfaces the command line arguments, allowing for
short- and long options. The class is implemented as a tt(Singleton).nl()
Manpage(arg)
bf(FBB::ArgConfig): Inherits from tt(Arg) and tt(ConfigFile) allowing for
options to be specified as command line options and/or configuration file
options. The class is implemented as a tt(Singleton).nl()
Manpage(argconfig)
bf(FBB::CmdFinder): Command-function associations.nl()
Manpage(cmdfinder)
bf(FBB::CmdFinderBase): Base class for tt(CmdFinder).nl()
Manpage(cmdfinderbase)
bf(FBB::Config): Processing standard configuration files.nl()
Manpage(configfile)
bf(FBB::ConfigFile): Processing standard configuration files (deprecated,
use bf(Config)).nl()
Manpage(configfile)
it() bf(CONVERSIONS)
bf(FBB::A2x): Ascii-to-x conversions of any type supporting extractions
from tt(i[string]stream) objects.
Manpage(a2x)
bf(FBB::BigInt): Wrapper class around the openssl BN_ functions for
unlimited integer precision arithmetic. nl()
Manpage(bigint)
bf(FBB::CSV4180): Objects of this class allow easy handling of
comma-separated values (implements RFC 4180).nl()
Manpage(csv)
COMMENT(
bf(FBB::CSV): Objects of this class allow easy handling of comma-separated
values.nl()
Manpage(csv)
END)
bf(FBB::IBase64Stream): stream implementing base64 encoding and decoding,
using a tt(FBB::Base64Streambuf) stream buffer.nl()
Manpage(ibase64stream)
bf(FBB::IBase64Buf): tt(FBB::IFilterBuf) specialization
implementing base64 encoding and decoding.nl()
Manpage(ibase64buf)
bf(FBB::IQuotedPrintableStream): stream implementing quoted printable
encoding and decoding, using a tt(FBB::IQuotedPrintableBuf) stream
buffer.nl()
Manpage(iquotedprintablestream)
bf(FBB::IQuotedPrintableBuf): tt(FBB::IFilterBuf)
specialization implementing quoted printable encoding and decoding.nl()
Manpage(iquotedprintablebuf)
bf(FBB::LDC): Large Digital Converter converts (large) values for various
radices. nl()
Manpage(ldc)
bf(FBB::X2a): x-to-Ascii conversions of any type supporting insertions
into tt(o[string]stream) objects.nl()
Manpage(x2a)
it() bf(DATE AND TIME)
bf(FBB::DateTime): Manipulations with date and time values.nl()
Manpage(datetime)
it() bf(ERRORS AND MESSAGE HANDLING)
bf(FBB::Exception): objects of this class accept tt(ostream) insertions,
and are also tt(std::exception) objects.nl()
Manpage(exception)
bf(FBB::level): Manipulator setting the log-level of tt(FBB::Log)
objects.nl()
Manpage(level)
bf(FBB::Log): tt(std::ostream) handling log messages.nl()
Manpage(log)
bf(FBB::LogBuf): tt(std::streambuf) handling log messages.nl()
Manpage(logbuf)
bf(FBB::SyslogBuf): streambuf to
Buffer generating bf(syslog)(3) messages. nl()
Manpage(syslogbuf)
bf(FBB::SyslogStream): stream to
Output stream inserting bf(syslog)(3) messages. nl()
Manpage(syslogstream)
it() bf(GENERIC ALGORITHM EXTENSIONS)
bf(FBB::binary_search): A modification of the STL tt(binary_search)
algorithm returning the location of the searched value in a sorted series
of values. nl()
Manpage(binarysearch)
bf(FBB::LinearMap): a class template container implementing a map using
a linear search algorithm.nl()
Manpage(linearmap)
bf(FBB::repeat): Two short extensions of the STL
tt(for_each) generic algorithm. nl()
Manpage(repeat)
it() bf(INTERNET / NETWORKING)
bf(FBB::CGI): a class implementing the facilities accessing the data made
available through the Common Gateway Interface.nl()
Manpage(cgi)
bf(FBB::Cidr): a class testing whether IP4 Internet addresses belong to
address ranges defined by Classless Inter-Domain Routing (CIDR) address
block specifications.nl()
Manpage(cidr)
bf(FBB::ClientSocket): a socket for tcp-communication with a server.nl()
Manpage(clientsocket)
bf(FBB::GetHostent): Obtains tt(hostent) struct from hostname or
-address. nl()
Manpage(gethostent)
bf(FBB::Hostname): Derived from tt(Hostent), allows the initialization
from a tt(std::string), or from an tt(FBB::InetAddrress). nl()
Manpage(hostname)
bf(FBB::InetAddress): Base class (no public constructor) for objects
representing an internet address as used with sockets. Contains address
and portnumbers. nl()
Manpage(inetaddress)
bf(FBB::Hostent): Wrapper around the tt(hostent) struct. nl()
Manpage(hostent)
bf(FBB::LocalClientSocket): a Unix domain socket for
tcp-communication with a Unix domain (local) server.nl()
Manpage(localclientsocket)
bf(FBB::LocalServerSocket): defines a Unix domain socket to which
clients on the local host can connect.nl()
Manpage(localserversocket)
bf(FBB::LocalSocketBase): Base class for tt(LocalClientSocket) and
tt(LocalServerSocket).
nl()
Manpage(localsocketbase)
bf(FBB::MailHeaders): extracts mail headers from SMTP-email.nl()
Manpage(mailheaders)
bf(FBB::Milter): interfaces the sendmail mail filter facilities.nl()
Manpage(milter)
bf(FBB::ServerSocket): defines a socket to which clients can connect.nl()
Manpage(serversocket)
bf(FBB::SocketBase): Base class for tt(ClientSocket) and tt(ServerSocket).
nl()
Manpage(socketbase)
it() bf(OPENSSL AND ENCRYPTION)
bf(FBB::BigInt): Wrapper class around the openssl BN_ functions for
unlimited integer precision arithmetic. nl()
Manpage(bigint)
bf(FBB::DiffieHellman): Computing shared keys using the Diffie-Hellman
algorithm.nl()
Manpage(diffiehellman)
bf(FBB::DigestBuf): Computing message digests.nl()
Manpage(digestbuf)
bf(FBB::ECDH): Computing shared keys using the elliptic curve based
Diffie-Hellman algorithm.nl()
Manpage(ecdh)
bf(FBB::HmacBuf): Computing HMAC message digests.nl()
Manpage(hmacbuf)
bf(FBB::ISymCryptStream): stream implementing symmetric encryption and
decryption, using a tt(FBB::ISymCryptStreambuf) stream buffer.nl()
Manpage(isymcryptstream)
bf(FBB::ISymCryptStreambuf): tt(FBB::IFilterBuf) specialization
implementing symmetric cryptography.nl()
Manpage(isymcryptstreambuf)
bf(FBB::OSymCryptStream): stream implementing symmetric encryption and
decryption, using a tt(FBB::OSymCryptStreambuf) stream buffer.nl()
Manpage(osymcryptstream)
bf(FBB::OSymCryptStreambuf): streambuf derived from tt(FBB::EoiBuf)
implementing symmetric cryptography.nl()
Manpage(osymcryptstreambuf)
it() bf(PATTERN MATCHING)
bf(FBB::Glob): Obtain a list of files matching a certain pattern.nl()
Manpage(glob)
bf(FBB::Pattern): Regular expression pattern matching.nl()
Manpage(pattern)
it() bf(PROCESSES, SIGNALS, THREADS)
bf(FBB::Exec): Executes child processes not expecting input and not
producing standard output. nl()
Manpage(exec)
bf(FBB::CerrExtractor): Executes child processes not expecting input but
maybe writing its standard error stream. nl()
Manpage(cerrextractor)
bf(FBB::CoutExtractor): Executes child processes not expecting input but
maybe producing standard output. nl()
Manpage(coutextractor)
bf(FBB::Fork): Defines bf(fork)(2) as part of a Template Algorithm Design
Pattern. nl()
Manpage(fork)
bf(FBB::CinInserter): Executes child processes expecting input but not
producing standard output. nl()
Manpage(cininserter)
bf(FBB::Process): Runs child processes, defining pipes between parents and
child processes. nl()
Manpage(process)
bf(FBB::Semaphore): Dijkstra's (1962) Semaphore data type.nl()
Manpage(semaphore)
bf(FBB::Signal): Defines signals, allowing signal handlers to use object's
data members c.q. to call object's members functions. nl()
Manpage(signal)
bf(FBB::StdExtractor): Executes child processes not expecting input but
maybe writing their standard output and error streams. nl()
Manpage(stdextractor)
it() bf(STREAMS AND FILES)
bf(FBB::DigestBuf): Computing message digests.nl()
Manpage(digestbuf)
bf(FBB::Eoi): tt(std::streambuf) offering the tt(eoi) manipulator.nl()
Manpage(eoi)
bf(FBB::EoiBuf): tt(std::streambuf) offering the tt(eoi) manipulator and a
configurable stream buffer.nl()
Manpage(eoibuf)
bf(FBB::IFdStream): stream extracting information from a device whose
file descriptor is available. nl()
Manpage(ifdstream)
bf(FBB::IFdBuf): Input stream buffer initialized by a file
descriptor.nl()
Manpage(ifdbuf)
bf(FBB::IFilterBuf): tt(std::streambuf) specialization implementing
an tt(std::istream) filtering design pattern.nl()
Manpage(ifilterbuf)
bf(FBB::IOStream): class combining tt(std::istream) and tt(std::ostream)
features. nl()
Manpage(iostream)
bf(FBB::IOBuf): tt(std::streambuf) specialization allowing combined
input and output operations. nl()
Manpage(iobuf)
bf(FBB::IRandStream): stream to extract random numbers from. nl()
(Manpage(irandstream))
bf(FBB::ISharedStream): tt(std::istream) operations on shared memory.nl()
Manpage(isharedstream)
bf(FBB::lm): Manipulator setting the left margin of tt(FBB::OFoldStream)
objects.nl()
Manpage(lm)
bf(FBB::Mbuf): tt(std::streambuf) specialization for inserting messages,
mainly used by tt(FBB::Mstream) objects. nl()
Manpage(mbuf)
bf(FBB::mlm): Manipulator modifying the left margin of
tt(FBB::OFoldStream) objects.nl()
Manpage(mlm)
bf(FBB::Mstream): Inserts messages into streams. nl()
Manpage(mstream)
bf(FBB::MultiBuf): tt(std::streambuf) specializations performing
insertions to multiple tt(std::ostream) objects.nl()
Manpage(multibuf)
bf(FBB::OMutexStream): Mutex protected tt(std::ostream).nl()
Manpage(mxstream)
bf(FBB::OFdStream): stream inserting information into a device whose
file descriptor is available. nl()
Manpage(ofdstream)
bf(FBB::OFdBuf): Output stream buffer initialized by a file
descriptor.nl()
Manpage(ofdbuf)
bf(FBB::OFilterBuf): tt(std::streambuf) specialization implementing
an tt(std::ostream) filtering design pattern.nl()
Manpage(ofilterbuf)
bf(FBB::OFoldStream): tt(std::ostream) using an tt(OFoldBuf) as its
streambuf. nl()
Manpage(ofoldstream)
bf(FBB::OFoldBuf): tt(OFilterBuf) (tt(std::streambuf))
specialization folding text lines between left and right margins.nl()
Manpage(ofoldbuf)
bf(FBB::OHexBuf): tt(OHexBuf) (tt(std::streambuf))
specialization inserting characters into a stream by their hex values.nl()
Manpage(ohexbuf)
bf(FBB::OSharedStream): tt(std::ostream) operations on shared memory.nl()
Manpage(osharedstream)
bf(FBB::Pipe): Defines a system level pipe. nl()
Manpage(pipe)
bf(FBB::RandBuf): implements a tt(streambuf) generating random
numbers. nl()
Manpage(randbuf)
bf(FBB::RandomMt): class template generating random numbers. nl()
Manpage(randommt)
bf(FBB::ReadLineBuf): implements a tt(streambuf) using the Gnu
tt(readline) library to allow editing an tt(std::istream)'s content. nl()
Manpage(readlinebuf)
bf(FBB::ReadLineHistory): provides access to the history of lines read
from a tt(ReadLineBuf). nl()
Manpage(readlinehistory)
bf(FBB::ReadLineStream): tt(std::istream) class using a tt(ReadLineBuf)
for its tt(std::streambuf). nl()
Manpage(readlinestream)
bf(FBB::Redirector): Defines system level file redirection. nl()
Manpage(redirector)
bf(FBB::Selector): Offers timed delays and multiple file I/O. nl()
Manpage(selector)
bf(FBB::SharedStream): I/O operations on shared memory.nl()
Manpage(sharedstream)
bf(FBB::SharedBuf): tt(std::streambuf) interfacing to shared
memory.nl()
Manpage(sharedbuf)
bf(FBB::Stat): Determines file characteristics.nl()
Manpage(stat)
bf(FBB::TempStream): Temporary fstream. nl()
Manpage(tempstream)
it() bf(SHARED MEMORY)
bf(FBB::ISharedStream): tt(std::istream) operations on shared memory.nl()
Manpage(isharedstream)
bf(FBB::OSharedStream): tt(std::ostream) operations on shared memory.nl()
Manpage(osharedstream)
bf(FBB::SharedBlock): Shared memory data block info.nl()
Manpage(sharedblock)
bf(FBB::SharedCondition): Shared memory condition variable.nl()
Manpage(sharedcondition)
bf(FBB::SharedMemory): Shared memory structure.nl()
Manpage(sharedmemory)
bf(FBB::SharedMutex): Mutex for shared memory.nl()
Manpage(sharedmutex)
bf(FBB::SharedPos): Shared Memory offset controller.nl()
Manpage(sharedpos)
bf(FBB::SharedReadme): Background info about the implementation of
Bobcat's Shared Memory.nl()
Manpage(sharedreadme)
bf(FBB::SharedSegment): Shared memory data structure.nl()
Manpage(sharedsegment)
bf(FBB::SharedStream): I/O operations on shared memory.nl()
Manpage(sharedstream)
bf(FBB::SharedBuf): tt(std::streambuf) interfacing to shared
memory.nl()
Manpage(sharedbuf)
it() bf(TABLES)
bf(FBB::Align): Specifies tt(Table(Buf)) column and element
alignments.nl()
Manpage(align)
bf(FBB::CSVTable): Construct tables row-by-row.nl()
Manpage(csvtable)
bf(FBB::Table): Display tables row- or column-wise.nl()
Manpage(CHAR(t)able)
bf(FBB::TableBuf): Display tables row- or column-wise.nl()
Manpage(CHAR(t)ablebuf)
bf(FBB::TableLines): Support class for the class tt(Table(Buf)).nl()
Manpage(tablelines)
bf(FBB::TableSupport): Support class for the class tt(Table(Buf)).nl()
Manpage(tablesupport)
it() bf(VARIOUS TEMPLATES)
bf(FBB::binary_search): A modification of the STL tt(binary_search)
algorithm returning the location of the searched value in a sorted series
of values. nl()
Manpage(binarysearch)
bf(FBB::BinOps): A series of function templates implementing binary
operators for classes that implement the matching binary assignment
operators themselves. nl()
Manpage(binops)
bf(FBB::BinOpsBase): A class template implementing binary
operators and compound assignment operators for classes that themselves
implement swap members and members implementing the basic binary operation
on objects of their class types themselves. nl()
Manpage(binopsbase)
bf(FBB::Field): class template retrieving and modifying position based
fields in numbers using configurable number systems. nl()
Manpage(field)
bf(FBB::fswap): templates implementing memory bytes based swap
functionality nl()
Manpage(fswap)
bf(FBB::Hash...): Various class templates implementing mapping containers
using hashing.nl()
Manpage(hash)
bf(FBB::Iterator): a class template creating a bidirectional iterator
returning values of a specified type.nl()
Manpage(iterator)
bf(FBB::LinearMap): a class template container implementing a map using
a linear search algorithm.nl()
Manpage(linearmap)
bf(FBB::PtrIter): Input iterator whose dereferenced value returns a
pointer rather than a reference to an element. Also offers: a tt(ptrIter)
function template. nl()
Manpage(ptriter)
bf(FBB::Ranger): a class template creating ranges that are accepted by
range-based for-loops. Also offered: a tt(ranger) function template. nl()
Manpage(ranger)
bf(FBB::repeat): Two short extensions of the STL
tt(for_each) generic algorithm. nl()
Manpage(repeat)
bf(FBB::Reverse): a class template creating a reverse iterator
returning values of a specified type.nl() Manpage(reverse)
bf(FBB::TypeTrait): Traits class template to determine various
characteristics of types.nl()
Manpage(typetrait)
it() bf(VARIOUS OTHER CLASSES)
bf(FBB::CSV): Objects of this class allow easy handling of comma-separated
values.nl()
Manpage(csv)
bf(FBB::Indent): Class and manipulators performing text indentation. nl()
Manpage(indent)
bf(FBB::Manipulators): manipulators defined in the namespace bf(FBB).nl()
Manpage(manipulators)
bf(FBB::OneKey): Single keystroke input, not requiring `Return'.nl()
Manpage(onekey)
bf(FBB::PrimeFactors): Pprime-number factorization of (BigInt) values.nl()
Manpage(primefactors)
bf(FBB::String): Offers extended tt(std::string) functionality.nl()
Manpage(string)
bf(FBB::StringLine): Offers tt(operator>>) extracting lines from
tt(std::istream) objects.nl()
Manpage(stringline)
bf(FBB::Tty): Controls echoing of characters entered at the terminal.nl()
Manpage(tty)
bf(FBB::User): Determines the current user's parameters from
tt(/etc/passwd).nl()
Manpage(user)
bf(FBB::Xpointer): sets and retrieves the X-windows pointer.nl()
Manpage(xpointer)
COMMENT(
it() bf(DEPRECATED CLASSES)
Deprecated classes should no longer be used. Their functionality is
better provided by other classes. The deprecated classes are no
longer maintained.nl()
bf(FBB::CSV): Comma separated values are now handled by the class
bf(CSV4180), implementing RFC 4180.nl()
END)
)
manpagesection(LINKING)
To link programs against the shared bf(Bobcat) library (e.g.,
tt(libbobcat5.so)) it is usually sufficient to merely specify
tt(-lbobcat). E.g.,
verb(
g++ --std=c++2a main.cc -lbobcat
)
Note: libraries that are indirectly required are no longer automatically
linked to your program. With some classes (e.g., tt(BigInt)) the tt(libcrypto)
library must also be specified, and programs using such classes must be linked
against tt(bobcat) and tt(crypto):
verb(
g++ --std=c++2a main.cc -lbobcat -lcrypto
)
Man-pages of classes requiring additional libraries mention these
additional libraries in their bf(SYNOPSIS) sections.
When using em(static) linking, the situation is slightly more problematic,
and no general rule can be provided here. To create a statically linked
program the flag tt(-static) must be provided, but in addition the
tt(-pthread) flag must often be specified as well. If, when statically linking
your program, undefined references to tt(pthread_...) identifiers are
reported, then that is a sure sign that you need to provide the tt(-pthread)
flag as well.
When using static linking additional libraries, not specified at the
man-pages, may also be required. E.g., when using the tt(Xpointer) class and
using static linking, the command becomes:
verb(
g++ main.cc -static -pthread -lbobcat -lX11 -lxcb -lXdmcp -lXau
)
When encountering undefined references when using static linking missing
libraries may be suggested by the linker or by its error
messages. Alternatively, the missing libraries may be found by searching the
Internet.
manpagefiles()
itemization(
itb(/usr/include/bobcat/<classname>)
itb(/usr/lib/libbobcat.*) (shared, static libraries)
)
manpageseealso()
The individual bf(bobcat/3<class>) header files, with man-pages accessible
using tt(man -e bobcat class) (all lowercase names)
manpagebugs()
No Reported Bugs.
includefile(include/trailer)
|
