bsearch: Initial man page.

This commit is contained in:
Ole Tange 2016-07-11 19:38:12 +02:00
parent 5020d3fbe7
commit 1e87eb8f2c
3 changed files with 266 additions and 11 deletions

View file

@ -1,12 +1,12 @@
CMD = blink histogram upsidedown tracefile timestamp rand rrm goodpasswd CMD = blink bsearch histogram upsidedown tracefile timestamp rand rrm goodpasswd
all: blink/blink.1 goodpasswd/goodpasswd.1 histogram/histogram.1 rand/rand.1 rrm/rrm.1 timestamp/timestamp.1 tracefile/tracefile.1 upsidedown/upsidedown.1 wssh/wssh.1 all: blink/blink.1 bsearch/bsearch.1 goodpasswd/goodpasswd.1 histogram/histogram.1 rand/rand.1 rrm/rrm.1 timestamp/timestamp.1 tracefile/tracefile.1 upsidedown/upsidedown.1 wssh/wssh.1
%.1: % %.1: %
pod2man $< > $@ pod2man $< > $@
install: install:
mkdir -p /usr/local/bin mkdir -p /usr/local/bin
parallel eval ln -sf `pwd`/*/{} /usr/local/bin/{} ::: blink reniced em field forever neno rn stdout tracefile w4it-for-port-open upsidedown histogram goodpasswd mtrr not summer timestamp transpose wssh aptsearch rand rrm parallel eval ln -sf `pwd`/*/{} /usr/local/bin/{} ::: blink bsearch reniced em field forever neno rn stdout tracefile w4it-for-port-open upsidedown histogram goodpasswd mtrr not summer timestamp transpose wssh aptsearch rand rrm
mkdir -p /usr/local/share/man/man1 mkdir -p /usr/local/share/man/man1
parallel ln -sf `pwd`/{} /usr/local/share/man/man1/{/} ::: */*.1 parallel ln -sf `pwd`/{} /usr/local/share/man/man1/{/} ::: */*.1

View file

@ -1,12 +1,260 @@
#!/usr/bin/perl #!/usr/bin/perl
=head1 NAME
bsearch - binary search through sorted text files
=head1 SYNOPSIS
B<bsearch> [-nrfB] file string [string...]
=head1 DESCRIPTION
B<bsearch> searches a sorted file for a string. It outputs the
following line or the byte position of this line, which is where the
string would have been if it had been in the sorted file.
=over 9
=item B<--ignore-leading-blanks> (not implemented)
=item B<-b>
ignore leading blanks
=item B<--byte-offset>
=item B<-B>
print byte position where string would have been
=item B<--dictionary-order> (not implemented)
=item B<-d>
consider only blanks and alphanumeric characters
=item B<--debug> (not implemented)
=item B<-D>
annotate the part of the line used to sort, and warn about
questionable usage to stderr
=item B<--ignore-case>
=item B<-f>
fold lower case to upper case characters
=item B<--general-numeric-sort> (not implemented)
=item B<-g>
compare according to general numerical value
=item B<--ignore-nonprinting> (not implemented)
=item B<-i>
consider only printable characters
=item B<--month-sort> (not implemented)
=item B<-M>
compare (unknown) < 'JAN' < ... < 'DEC'
=item B<--human-numeric-sort> (not implemented)
=item B<-h>
compare human readable numbers (e.g., 2K 1G)
=item B<--key=KEYDEF> (not implemented)
=item B<-k>
sort via a key; KEYDEF gives location and type
=item B<--numeric-sort>
=item B<-n>
compare according to string numerical value
=item B<--random-sort> (not implemented)
=item B<-R>
sort by random hash of keys
=item B<--reverse>
=item B<-r>
reverse the result of comparisons
=item B<--sort=WORD> (not implemented)
sort according to WORD: general-numeric B<-g>, human-numeric B<-h>, month
B<-M>, numeric B<-n>, random B<-R>, version B<-V>
=item B<-t> (not implemented)
=item B<--field-separator=SEP>
use SEP instead of non-blank to blank transition
=item B<-z> (not implemented)
=item B<--zero-terminated>
end lines with 0 byte, not newline
=back
=head1 EXAMPLES
=head2 Missing
Missing
=head1 REPORTING BUGS
B<bsearch> is part of tangetools. Report bugs to <tools@tange.dk>.
=head1 AUTHOR
Copyright (C) 2016 Ole Tange http://ole.tange.dk
=head1 LICENSE
Copyright (C) 2013 Free Software Foundation, Inc.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
at your option any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
=head2 Documentation license I
Permission is granted to copy, distribute and/or modify this documentation
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the file fdl.txt.
=head2 Documentation license II
You are free:
=over 9
=item B<to Share>
to copy, distribute and transmit the work
=item B<to Remix>
to adapt the work
=back
Under the following conditions:
=over 9
=item B<Attribution>
You must attribute the work in the manner specified by the author or
licensor (but not in any way that suggests that they endorse you or
your use of the work).
=item B<Share Alike>
If you alter, transform, or build upon this work, you may distribute
the resulting work only under the same, similar or a compatible
license.
=back
With the understanding that:
=over 9
=item B<Waiver>
Any of the above conditions can be waived if you get permission from
the copyright holder.
=item B<Public Domain>
Where the work or any of its elements is in the public domain under
applicable law, that status is in no way affected by the license.
=item B<Other Rights>
In no way are any of the following rights affected by the license:
=over 9
=item *
Your fair dealing or fair use rights, or other applicable
copyright exceptions and limitations;
=item *
The author's moral rights;
=item *
Rights other persons may have either in the work itself or in
how the work is used, such as publicity or privacy rights.
=back
=item B<Notice>
For any reuse or distribution, you must make clear to others the
license terms of this work.
=back
A copy of the full license is included in the file as cc-by-sa.txt.
=head1 DEPENDENCIES
B<timestamp> uses Perl and the Getopt::Long and Time::HiRes modules.
=head1 SEE ALSO
B<sort>(1)
=cut
use Getopt::Long; use Getopt::Long;
Getopt::Long::Configure("bundling","require_order");
GetOptions( GetOptions(
"debug|D=s" => \$opt::D, "debug|D=s" => \$opt::D,
"version" => \$opt::version, "version" => \$opt::version,
"verbose|v" => \$opt::verbose, "verbose|v" => \$opt::verbose,
"B|byte-offset" => \$opt::byte_offset,
"b|ignore-leading-blanks" => \$opt::ignore_leading_blanks, "b|ignore-leading-blanks" => \$opt::ignore_leading_blanks,
"d|dictionary-order" => \$opt::dictionary_order, "d|dictionary-order" => \$opt::dictionary_order,
"f|ignore-case" => \$opt::ignore_case, "f|ignore-case" => \$opt::ignore_case,
@ -28,11 +276,12 @@ if($opt::version) {
version(); version();
exit 0; exit 0;
} }
if($opt::zero_terminated) { $/ = "\0"; }
my $file = shift; my $file = shift;
for my $key (@ARGV) { for my $key (@ARGV) {
print bsearch($file,$key),"\n"; print bsearch($file,$key);
} }
sub bsearch { sub bsearch {
@ -47,7 +296,7 @@ sub bsearch {
} }
my $line; my $line;
while($max - $min > 1) { while($max - $min > 1) {
$middle = int(($max+$min)/2); $middle = int(($max + $min)/2);
seek($fh,$middle,0) or die; seek($fh,$middle,0) or die;
my $half = <$fh>; my $half = <$fh>;
if(eof($fh) if(eof($fh)
@ -61,16 +310,21 @@ sub bsearch {
seek($fh,$max,0) or die; seek($fh,$max,0) or die;
$line = <$fh>; $line = <$fh>;
if(compare($line,$key) >= 0) { if(compare($line,$key) >= 0) {
return 0; if($opt::byte_offset) {
return "0\n";
} else {
# The very first line
return "";
}
} else { } else {
return tell $fh; if($opt::byte_offset) {
return tell($fh)."\n";
} else {
return $line;
}
} }
} }
# -n, --numeric-sort
# -r --reverse
# -f, --ignore-case
sub compare { sub compare {
my ($a,$b) = @_; my ($a,$b) = @_;
if($opt::reverse) { if($opt::reverse) {

View file

@ -36,6 +36,7 @@ test_n() {
echo 3.000000000 >> $tmp echo 3.000000000 >> $tmp
xargs < $tmp xargs < $tmp
bsearch -n $tmp 0 2 2.1 100000 bsearch -n $tmp 0 2 2.1 100000
rm $tmp
} }