/usr/share/doc/libbobcat4-dev/man/tty.3.html is in libbobcat-dev 4.08.02-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html><html><head>
<meta charset="UTF-8">
<title>FBB::Tty(3bobcat)</title>
<style type="text/css">
figure {text-align: center;}
img {vertical-align: center;}
.XXfc {margin-left:auto;margin-right:auto;}
.XXtc {text-align: center;}
.XXtl {text-align: left;}
.XXtr {text-align: right;}
.XXvt {vertical-align: top;}
.XXvb {vertical-align: bottom;}
</style>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr/>
<h1 id="title">FBB::Tty(3bobcat)</h1>
<h2 id="author">Controls echoing of characters<br/>(libbobcat-dev_4.08.02-x.tar.gz)</h2>
<h2 id="date">2005-2017</h2>
<p>
<h2 >NAME</h2>FBB::Tty - Controls echoing of characters entered at the terminal
<p>
<h2 >SYNOPSIS</h2>
<strong >#include <bobcat/tty></strong><br/>
Linking option: <em >-lbobcat</em>
<p>
<h2 >DESCRIPTION</h2>
<strong >Tty</strong>(3bobcat) objects can be used to control the echoing of characters
entered at the terminal (usually at <em >/dev/tty</em>). Directly reading from
<em >/dev/tty</em> allows programs to read information (e.g., passwords or pass
phrases) even if the standard input stream is redirected to a file. Unless
redirected, <em >std::cin</em> is connected to <em >/dev/tty</em>.
<p>
<strong >Tty</strong>(3bobcat) objects may be used as stand-alone objects or (usually
anonymous) <strong >Tty</strong>(3bobcat) objects may be inserted into or extracted from
streams. When inserting or extracting objects the involved streams are not
affected; only the echoing of characters entered at <em >/dev/tty</em> is
manipulated.
<p>
<strong >Tty</strong>(3bobcat)'s destructor does not reset the echo-state of
<em >/dev/tty</em> to its original value. If that is required a <strong >Tty</strong>(3bobcat)
object must be created first, calling its <strong >echo(Tty::RESET)</strong> member at the
appropriate time.
<p>
<h2 >NAMESPACE</h2>
<strong >FBB</strong><br/>
All constructors, members, operators and manipulators, mentioned in this
man-page, are defined in the namespace <strong >FBB</strong>.
<p>
<h2 >INHERITS FROM</h2>
-
<p>
<h2 >ENUM</h2>
<p>
The <em >enum EchoType</em> requests the type of echo-handling:
<ul>
<li> <strong >RESET</strong> is used to reset <em >/dev/tty</em>'s state to the actual state
when a <strong >Tty</strong>(3bobcat) object was constructed
<li> <strong >ON</strong> is used to activate echoing of characters entered at
<em >/dev/tty</em>.
<li> <strong >OFF</strong> is used to suppress echoing of characters entered at
<em >/dev/tty</em>.
</ul>
<p>
<h2 >CONSTRUCTORS</h2>
<ul>
<li> <strong >Tty()</strong>:<br/>
The current state of <em >/dev/tty</em> is saved.
<p>
<li> <strong >Tty(EchoType type)</strong>:<br/>
The current state of <em >/dev/tty</em> is saved, and the object's member
<em >echo(type)</em> is called.
</ul>
Default copy and move constructors are available.
<p>
<h2 >OVERLOADED OPERATORS</h2>
<ul>
<li> <strong >std::istream &operator>>(std::istream &in, Tty const &tty)</strong>:<br/>
The extraction operator does not affect <em >in</em>, but <em >/dev/tty</em>'s
state is set according to the way the <em >tty</em> object was constructed.
<p>
<li> <strong >std::ostream &operator<<(std::ostream &out, Tty const &tty)</strong>:<br/>
The insertion operator does not affect <em >out</em>, but <em >/dev/tty</em>'s
state is set according to the way the <em >tty</em> object was constructed.
</ul>
Default copy and move assignment operators are available.
<p>
<h2 >MEMBER FUNCTION</h2>
<p>
<ul>
<li> <strong >echo(EchoType type)</strong>:<br/>
<em >/Dev/tty</em>'s state is set according to the <em >EchoType</em> value that is
passed to this member.
</ul>
<p>
<h2 >EXAMPLE</h2>
<p>
<pre >
#include <iostream>
#include <string>
#include <bobcat/tty>
using namespace std;
using namespace FBB;
int main()
{
cout << "Enter some text (not echoed): " << Tty(Tty::OFF);
string line;
getline(cin, line);
cout << "\n"
"You entered: `" << line << "'\n";
cout << "Enter some text (echoed): ";
getline(cin >> Tty(Tty::ON), line);
cout << "You entered: `" << line << "'\n";
}
</pre>
<p>
<h2 >FILES</h2>
<em >bobcat/tty</em> - defines the class interface
<p>
<h2 >SEE ALSO</h2>
<strong >bobcat</strong>(7), <strong >onekey</strong>(3bobcat)
<p>
<h2 >BUGS</h2>
None Reported.
<p>
<h2 >DISTRIBUTION FILES</h2>
<ul>
<li> <em >bobcat_4.08.02-x.dsc</em>: detached signature;
<li> <em >bobcat_4.08.02-x.tar.gz</em>: source archive;
<li> <em >bobcat_4.08.02-x_i386.changes</em>: change log;
<li> <em >libbobcat1_4.08.02-x_*.deb</em>: debian package holding the
libraries;
<li> <em >libbobcat1-dev_4.08.02-x_*.deb</em>: debian package holding the
libraries, headers and manual pages;
<li> <em >http://sourceforge.net/projects/bobcat</em>: public archive location;
</ul>
<p>
<h2 >BOBCAT</h2>
Bobcat is an acronym of `Brokken's Own Base Classes And Templates'.
<p>
<h2 >COPYRIGHT</h2>
This is free software, distributed under the terms of the
GNU General Public License (GPL).
<p>
<h2 >AUTHOR</h2>
Frank B. Brokken (<strong >f.b.brokken@rug.nl</strong>).
<p>
</body>
</html>
|