Commit ab59f144 authored by Frank B. Brokken's avatar Frank B. Brokken

updated man-pages

parent 99473c06
......@@ -12,7 +12,7 @@ manpagesynopsis()
Linking option: tt(-lbobcat)
manpagedescription()
bf(FBB::IFdBuf) objects may be used as a bf(std::streambuf) of
bf(FBB::IFdBuf) objects may be used as a tt(std::streambuf) of
tt(std::istream) objects to allow extractions from a file descriptor.
File descriptors are not defined within the context of bf(C++),
......@@ -25,7 +25,7 @@ manpagesection(INHERITS FROM)
bf(std::streambuf)
manpagesection(ENUMERATION)
The public enumeration bf(Mode) defined in the class bf(FBB::IFdStreamBuf)
The public enumeration tt(Mode) defined in the class tt(FBB::IFdStreamBuf)
has the following values:
itemization(
it() bf(CLOSE_FD), indicating that the file descriptor used by the object
......@@ -41,43 +41,43 @@ manpagesection(CONSTRUCTORS)
a file descriptor, and without using buffering. The member tt(reset) can be
used subsequently to associate the object with a file descriptor and
optionally a buffer size. When the object is destroyed or if the mode-less
overloaded version of the bf(open) member is called, the file descriptor will
not be closed.
overloaded version of the tt(reset) member is called, the file descriptor is
not closed.
itb(IFdBuf(Mode mode))
This constructor initializes the streambuf, without associating it to
a file descriptor, and without using buffering. The member bf(open()) can be
a file descriptor, and without using buffering. The member tt(reset) can be
used subsequently to associate the object with a file descriptor and
optionally a buffer size. When the object is destroyed or if the mode-less
overloaded version of the bf(open) member is called, the bf(Mode) argument
overloaded version of the member tt(reset) is called, the tt(Mode) argument
determines whether the file descriptor will be closed or will remain open.
itb(IFdBuf(int fd, size_t n = 1))
This constructor initializes the streambuf, associating it to file
descriptor tt(fd), and an optional unget buffer size (by default having size
1). When the object is destroyed or if the mode-less overloaded version of
the bf(open) member is called, the file descriptor will not be closed.
the member tt(reset) is called, the file descriptor is not closed.
itb(IFdBuf(int fd, Mode mode, size_t n = 1))
This constructor initializes the streambuf, associating it to file
descriptor tt(fd), and an optional unget buffer size (by default having size
1). When the object is destroyed or if the mode-less
overloaded version of the bf(open) member is called, the bf(Mode) argument
overloaded version of the tt(reset) member is called, the tt(Mode) argument
determines whether the file descriptor will be closed or will remain open.
)
Copy and move constructors (and assignment operators) are not available.
manpagesection(MEMBER FUNCTIONS)
All members of bf(std::streambuf) are
available, as bf(FBB::IFdBuf) inherits from this class.
All members of tt(std::streambuf) are
available, as tt(FBB::IFdBuf) inherits from this class.
itemization(
itb(void close())
The file descriptor used by the tt(IFdBuf) is closed,
irrespective of the tt(Mode) that was specified when the tt(IFdBuf)
object was constructed. Following tt(close) the tt(IFdBuf) object can
no longer be used until one of its tt(open) members has been called.
no longer be used until one of its tt(reset) members has been called.
itb(int fd() const)
The file descriptor used by the tt(IFdBuf) object is returned.
......@@ -87,13 +87,13 @@ no longer be used until one of its tt(open) members has been called.
itb(void reset(int fd, size_t n = 1))
The streambuf is (re)initialized, using file descriptor tt(fd), and an
optional unget buffer size (by default having size 1). When called repeatedly,
the bf(Mode) specification used whem the object was constructed determines
the tt(Mode) specification used whem the object was constructed determines
whether the file descriptor will be closed or will remain open.
itb(void reset(int fd, Mode mode, size_t n = 1))
The streambuf is (re)initialized, using file descriptor tt(fd), a file
descriptor closing parameter and an optional unget buffer size (by default
having size 1). Depending on the bf(Mode) argument the object's currently used
having size 1). Depending on the tt(Mode) argument the object's currently used
file descriptor will be closed or will remain open when the tt(IFdBuf)
object is destroyed.
)
......
......@@ -12,7 +12,7 @@ manpagesynopsis()
Linking option: tt(-lbobcat)
manpagedescription()
bf(FBB::OFdBuf) objects may be used as a bf(std::streambuf) of
bf(FBB::OFdBuf) objects may be used as a tt(std::streambuf) of
tt(std::ostream) objects to allow insertions into a file descriptor.
File descriptors are not defined within the context of bf(C++),
......@@ -25,7 +25,7 @@ manpagesection(INHERITS FROM)
bf(std::streambuf)
manpagesection(ENUMERATION)
The public enumeration bf(Mode) defined in the class bf(FBB::OFdStreamBuf)
The public enumeration tt(Mode) defined in the class tt(FBB::OFdStreamBuf)
has the following values:
itemization(
it() bf(CLOSE_FD), indicating that the file descriptor used by the object
......@@ -38,43 +38,43 @@ manpagesection(CONSTRUCTORS)
itemization(
itb(OFdBuf())
This constructor initializes the streambuf, without associating it to
a file descriptor, and without using buffering. The member bf(open()) can be
a file descriptor, and without using buffering. The member tt(reset) can be
used to associate the object later on with a file descriptor and optionally a
buffer size. When the object is destroyed or if the mode-less overloaded
version of the bf(open) member is called, the file descriptor will be closed.
version of the tt(reset) member is called, the file descriptor is closed.
itb(OFdBuf(Mode mode))
This constructor initializes the streambuf, without associating it to
a file descriptor, and without using buffering. The member bf(open()) can be
a file descriptor, and without using buffering. The member tt(reset) can be
used to associate the object later on with a file descriptor and optionally a
buffer size. When the object is destroyed or if the mode-less
overloaded version of the bf(open) member is called, the bf(Mode) argument
overloaded version of the member tt(reset) is called, the tt(Mode) argument
determines whether the file descriptor will be closed or will remain open.
itb(OFdBuf(int fd, size_t n = 1))
This constructor initializes the streambuf, associating it to file
descriptor tt(fd), and an optional unget buffer size (by default having size
1). When bf(open) is called subsequently, or if the object is destroyed
1). When tt(reset) is called subsequently, or if the object is destroyed
the provided file descriptor will be closed.
itb(OFdBuf(int fd, size_t n = 1))
This constructor initializes the streambuf, associating it to file
descriptor tt(fd), and an optional unget buffer size (by default having size
1). When the object is destroyed or if the mode-less overloaded version of
the bf(open) member is called, the file descriptor will be closed.
the member tt(reset) is called, the file descriptor will be closed.
itb(OFdBuf(int fd, Mode mode, size_t n = 1))
This constructor initializes the streambuf, associating it to file
descriptor tt(fd), and an optional unget buffer size (by default having size
1). When the object is destroyed or if the mode-less overloaded version of
the bf(open) member is called, the bf(Mode) argument determines whether the
the member tt(reset) is called, the tt(Mode) argument determines whether the
file descriptor will be closed or will remain open.
)
Copy and move constructors (and assignment operators) are not available.
manpagesection(MEMBER FUNCTIONS)
All members of bf(std::streambuf) are available, as bf(FBB::OFdBuf)
All members of tt(std::streambuf) are available, as tt(FBB::OFdBuf)
inherits from this class.
itemization(
itb(void eoi())
......@@ -92,13 +92,13 @@ of using this member the tt(eoi) manipulator can also be used.
itb(void reset(int xfd, size_t n = 1))
The streambuf is (re)initialized, using file descriptor tt(fd), and an
optional unget buffer size (by default having size 1). When called repeatedly,
the bf(Mode) specification used whem the object was constructed determines
the tt(Mode) specification used whem the object was constructed determines
whether the file descriptor will be closed or will remain open.
itb(void reset(int xfd, Mode mode, size_t n = 1))
The streambuf is (re)initialized, using file descriptor tt(fd), a file
descriptor closing parameter and an optional unget buffer size (by default
having size 1). Depending on the bf(Mode) argument the object's currently used
having size 1). Depending on the tt(Mode) argument the object's currently used
file descriptor will be closed or will remain open when the tt(IFdBuf)
object is destroyed.
)
......
......@@ -75,7 +75,7 @@ rowline()
includefile(include/namespace)
manpagesection(INHERITS FROM)
FBB::OFilterBuf
tt(FBB::OFilterBuf)
manpagesection(ENUMERATION)
The enumeration tt(TabsOrBlanks) is used to select tabs or blanks when
......@@ -139,7 +139,7 @@ and will then flush the destination stream.
manpagesection(MEMBER FUNCTIONS)
All members of bf(FBB::OFilterBuf), in particular its tt(out()) and
tt(open()) members are available, as bf(FBB::OFoldBuf) inherits from
tt(reset) members are available, as bf(FBB::OFoldBuf) inherits from
this class.
itemization(
itb(void setMargins(size_t leftMargin, size_t rightMargin))
......
......@@ -26,8 +26,7 @@ inserted into the destination stream.
includefile(include/namespace)
manpagesection(INHERITS FROM)
FBB::OFilterBuf
tt(FBB::OFilterBuf)
manpagesection(CONSTRUCTOR)
itemization(
......@@ -49,7 +48,7 @@ original formatting flags of the receiving tt(ostream).
manpagesection(MEMBER FUNCTIONS)
All members of bf(FBB::OFilterBuf), in particular its tt(out()) and
tt(open()) members are available, as bf(FBB::OHexBuf) inherits from
tt(reset) members are available, as bf(FBB::OHexBuf) inherits from
this class.
itemization(
itb(void eoi())
......
......@@ -32,7 +32,7 @@ is cleared.
includefile(include/namespace)
manpagesection(INHERITS FROM)
bf(std::streambuf)
tt(FBB::EoiBuf) and thus from tt(std::streambuf)
manpagesection(ENUMERATIONS)
......@@ -106,15 +106,14 @@ bf(LOG_xxx) values used with bf(syslog)(3):
UUCP subsystem
)
manpagesection(CONSTRUCTORS)
manpagesection(CONSTRUCTOR)
itemization(
itb(SyslogBuf(string const &ident = "",
FBB::Priority priority = FBB::NOTICE,
FBB::Facility facility = FBB::USER,
int option = 0))
This constructor initializes a bf(SyslogBuf) object. The
tt(ident) parameter is usually the name of the program. Its contents are
prepended to syslog messages.
The tt(ident) parameter is usually the name of the program. Its
contents are prepended to syslog messages.
The tt(priority) parameter determines the default importance of the message
sent to the syslog daemon. By default messages are sent to the syslog daemon
......@@ -130,7 +129,6 @@ set by the static member tt(setMask) (see below).
The tt(facility) parameter determines the type of program doing the
logging. By default bf(FBB::USER) is used.
The tt(option) parameter may be used to specify various options (use the
binary `tt(bitor)' (`tt(|)') operator to combine options):
......@@ -156,13 +154,17 @@ manpagesection(MEMBER FUNCTIONS)
inherits from this class.
itemization(
itb(void close())
If the bf(SyslogStream)'s internal buffer is not empty it is flushed to
the syslog daemon. Thereafer bf(closelog)(3) is called.
itb(Priority defaultPriority() const)
Returns the current default priority. I.e., the priority that will be
used for the messages after inserting tt(endl) or tt(flush).
itb(void open(string const &ident,
itb(void eoi())
If the bf(SyslogStream)'s internal buffer is not empty it is flushed to
the syslog daemon. Thereafer bf(closelog)(3) is called. Instead
of using this member the tt(eoi) manipulator can also be used.
itb(Priority priority() const)
Returns the next priority. I.e., the priority that will be used for
the next message that is sent to the syslog daemon.
itb(void reset(string const &ident,
FBB::Priority priority = FBB::NOTICE,
FBB::Facility facility = FBB::USER,
int option = 0))
......@@ -171,9 +173,6 @@ inherits from this class.
bf(SyslogStream)'s internal buffer is not empty it is first flushed to
the syslog daemon using the identifier, priority and options that were
active just before calling tt(open).
itb(Priority priority() const)
Returns the next priority. I.e., the priority that will be used for
the next message that is sent to the syslog daemon.
itb(Priority setDefaultPriority(Priority priority))
Changes the default priority of the next message that is sent to the
syslog daemon after inserting tt(std::eoln) or
......@@ -186,6 +185,16 @@ inherits from this class.
returned.
)
manpagesection(MANIPULATOR)
itemization(
itb(FBB::eoi)
The tt(eoi) manipulator can be inserted into the tt(ostream) instead
of calling the tt(SyslogBuf::end) member. It performs the same actions as
the tt(eoi) member. If inserted into a plain tt(std::ostream) nothing
happens.
)
manpagesection(EXAMPLE)
See also bf(syslogstream)(3bobcat)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment