rfgrep 0.5.0

Advanced recursive file grep utility with comprehensive file type classification - search, list, and analyze 153+ file formats with intelligent filtering and safety policies
Documentation 
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

# rfgrep Man Pages

This directory contains comprehensive man pages for the `rfgrep` utility and its subcommands.

## Man Pages Included

- **rfgrep.1** - Main man page for the rfgrep utility
- **rfgrep-search.1** - Detailed documentation for the search command
- **rfgrep-interactive.1** - Documentation for interactive search mode
- **rfgrep-list.1** - Documentation for the list command
- **rfgrep-completions.1** - Documentation for shell completion generation

## Installation

### System-wide Installation (requires sudo)

```bash
cd man
sudo make install
```

### User Installation (no sudo required)

```bash
cd man
make install-user
```

Then add to your shell profile (`.bashrc`, `.zshrc`, etc.):

```bash
export MANPATH=$MANPATH:$HOME/.local/share/man
```

## Usage

After installation, you can view the man pages:

```bash
# Main man page
man rfgrep

# Command-specific man pages
man rfgrep-search
man rfgrep-interactive
man rfgrep-list
man rfgrep-completions
```

## Development

### Preview Man Pages

```bash
cd man
make preview
```

### Check Syntax

```bash
cd man
make check
```

### Validate Format

```bash
cd man
make validate
```

### Clean Generated Files

```bash
cd man
make clean
```

## Man Page Features

### Comprehensive Documentation
- Complete command reference
- Detailed option descriptions
- Practical examples
- Performance tips
- Troubleshooting guides

### Cross-references
- Links between related man pages
- References to similar tools (grep, ripgrep, find)
- See also sections for additional resources

### Examples
- Real-world usage examples
- Output format demonstrations
- Performance optimization tips
- Common use cases

### Troubleshooting
- Common issues and solutions
- Performance optimization
- Error handling
- Debugging tips

## Man Page Structure

Each man page follows the standard Unix man page format:

1. **NAME** - Command name and brief description
2. **SYNOPSIS** - Command syntax
3. **DESCRIPTION** - Detailed explanation
4. **OPTIONS** - Command-line options
5. **EXAMPLES** - Usage examples
6. **EXIT STATUS** - Return codes
7. **NOTES** - Additional information
8. **SEE ALSO** - Related commands

## Contributing

When updating man pages:

1. Follow the standard man page format
2. Include comprehensive examples
3. Add cross-references to related pages
4. Test with `make check` and `make validate`
5. Update the version number in the header

## Formatting

The man pages use standard troff formatting:

- `.TH` - Title header
- `.SH` - Section headers
- `.TP` - Tagged paragraphs
- `.B` - Bold text
- `.I` - Italic text
- `.RS/.RE` - Relative start/end
- `.PP` - Paragraph break

## Distribution

These man pages are included in the rfgrep distribution and can be installed alongside the binary. They provide comprehensive documentation for all rfgrep features and commands.