File: README.md

package info (click to toggle)
ruby-file-tail 1.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 208 kB
  • sloc: ruby: 890; makefile: 3
file content (73 lines) | stat: -rw-r--r-- 1,667 bytes parent folder | download
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
# File::Tail for Ruby

## Description

This is a small ruby library that allows it to "tail" files in Ruby, including
following a file, that still is growing like the unix command 'tail -f' can.

## Download

The latest version of *File::Tail* (file-tail) can be found at


http://flori.github.com/file-tail

## Installation

To install file-tail via its gem type:

# gem install file-tail

## Usage

File::Tail is a module in the File class. A lightweight class interface for
logfiles can be seen under File::Tail::Logfile.

Direct extension of File objects with File::Tail works like that:

    File.open(filename) do |log|
      log.extend(File::Tail)
      log.interval # 10
      log.backward(10)
      log.tail { |line| puts line }
    end

It's also possible to mix File::Tail in your own File classes
(see also File::Tail::Logfile):

    class MyFile < File
      include File::Tail
    end
    log # MyFile.new("myfile")
    log.interval # 10
    log.backward(10)
    log.tail { |line| print line }

The forward/backward method returns self, so it's possible to chain
methods together like that:

    log.backward(10).tail { |line| puts line }

A command line utility named rtail, that uses File::Tail is provided as well.

## Documentation

To create the documentation of this module, type

```
$ rake doc
```

and the API documentation is generated.

In the examples direcotry is a small example of tail and
pager program that use this module. You also may want look
at the end of examples/tail.rb for a little example.

## Author

Florian Frank mailto:flori@ping.de

## License

Apache License, Version 2.0 – See the COPYING file in the source archive.