← Back to branch summary

~ubuntu-branches/ubuntu/precise/postgresql-9.1/precise-security

« back to all changes in this revision

Viewing changes to src/tools/entab/entab.man

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2011-05-11 10:41:53 UTC
  • Revision ID: james.westby@ubuntu.com-20110511104153-psbh2o58553fv1m0
Tags: upstream-9.1~beta1
Import upstream version 9.1~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/tools/entab/entab.man
 
1
.\" src/tools/entab/entab.man
 
2
.TH ENTAB 1 local
 
3
.SH NAME
 
4
entab - tab processor
 
5
.SH SYNOPSIS
 
6
.nf
 
7
entab [-cdq] [-s min_spaces] [-t tab_width] [file ... ]
 
8
detab [-cq]  [-s min_spaces] [-t tab_width] [file ... ]
 
9
.fi
 
10
.SH DESCRIPTION
 
11
Entab is a program designed to selectively add or remove tabs
 
12
from a file based on user-supplied criteria.
 
13
In default mode, entab prints the specified files to standard output
 
14
with the optimal mix of tabs and spaces.
 
15
Tabs default to every 8 characters, and tabs are used only when they
 
16
can replace more than one space, unlike 'col' which uses tabs wherever
 
17
possible.
 
18
.LP
 
19
The options are:
 
20
.in +0.5i
 
21
.nf
 
22
-c      Clip trailing tabs and spaces from each line.
 
23
-d      Delete all tabs from output
 
24
-q      Protect single and double-quoted strings from tab replacement.
 
25
        (This option is useful when operating on source code.
 
26
         Line continuation with back-slashes is also understood.)
 
27
-s      Minimum spaces needed to replace with a tab (default = 2).
 
28
-t      Number of spaces in a tab stop (default = 8).
 
29
.fi
 
30
.in -0.5i
 
31
Detab is equivalent to entab -d.
 
32
.SH NOTES
 
33
Entab has improved tab handling for certain situations.
 
34
It only replaces tabs if there is a user-defined number of spaces
 
35
to be saved.
 
36
Other tab replacement programs put tabs wherever
 
37
possible, so if two words are separated by one space, and that
 
38
space is on a tab stop, a tab is inserted.
 
39
Then, when words are added to the left, the words are shifted over,
 
40
leaving a large gap.
 
41
The quote-protection option allows tab replacement without
 
42
quoted strings being changed.
 
43
Useful when strings in source code will not have the same tab stops
 
44
when executed in the program.
 
45
.LP
 
46
To change a text file created on a system with one size of tab
 
47
stop to display properly on a device with different tab setting,
 
48
use detab (or entab -d) to remove tabs from the file with the
 
49
tab size set to the original tab size, then use entab to re-tab
 
50
the file with the new tab size.
 
51
.SH AUTHOR
 
52
Bruce Momjian, root@candle.pha.pa.us