path: root/Master/texmf-dist/doc/man/man1/srcredact.1

.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "SRCREDACT 1"
.TH SRCREDACT 1 "2015-10-24" "1.0" "Text tools"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
srcredact \- a program for redaction of text files
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
srcredact [\fI\s-1OPTIONS\s0\fR] \fB\-e\fR \fIaudience\fR [\fIfull_file\fR]
.PP
srcredact [\fI\s-1OPTIONS\s0\fR] \fB\-u\fR \fIaudience\fR \fIfull_file\fR [\fIredacted_file\fR]
.PP
srcredact \fB\-l\fR [\fIfull_file\fR]
.PP
srcredact \fB\-h|\-v\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBsrcredact\fR is the program to extract ``redacted versions'' of the
master file (option \fB\-e\fR) or to incorporate the changes in the
redacted versions into the master file (``unredact'', option \fB\-u\fR).
.PP
The master file consists of \fIchunks\fR intended for different
audiences.  Each audience has a \fIname\fR, e.g. \f(CW\*(C`classified\*(C'\fR,
\&\f(CW\*(C`unclssified\*(C'\fR, \f(CW\*(C`expert\*(C'\fR etc.  Chunks are started and stopped by
\&\fIguard lines\fR.  Each guard line has the format (for the default TeX
syntax)
.PP
.Vb 1
\&  %<*name1|name2|...>
.Ve
.PP
or
.PP
.Vb 1
\&  %</name1|name2|...>
.Ve
.PP
In the first cases the text following the guard is \fIincluded\fR for the
audiences \f(CW\*(C`name1\*(C'\fR, \f(CW\*(C`name2\*(C'\fR, ....  In the second case it is
\&\fIexcluded\fR for these audiences.
.PP
THere is a special audience \f(CW\*(C`ALL\*(C'\fR: a wild card for all audiences.
Thus the idiom
.PP
.Vb 2
\&  %</ALL>
\&  %<*classified>
.Ve
.PP
means that the chunk is excluded for all audiences but \f(CW\*(C`classified\*(C'\fR
.PP
Exactly one of the options  \fB\-e\fR (extract) or \fB\-u\fR (unextract) must be
present.  In  the extract mode the  non-option argument is  the name of
the full file.   If it is absent, or is \f(CW\*(C`\-\*(C'\fR,  standard input is used.
In the unextract mode the first non-option argument
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-c\fR \fIlist of comment patterns\fR" 4
.IX Item "-c list of comment patterns"
Use the given pattern for comment lines to search for guards instead
of the default \f(CW\*(C`TeX\*(C'\fR pattern.  The recognized patterns are:
.RS 4
.IP "\fBc\fR" 4
.IX Item "c"
.Vb 1
\&  /*<guard>*/
.Ve
.IP "\fBcpp\fR" 4
.IX Item "cpp"
.Vb 1
\&  //<guard>
.Ve
.IP "\fBfortran\fR" 4
.IX Item "fortran"
.Vb 1
\&  C<guard>
.Ve
.IP "\fBshell\fR" 4
.IX Item "shell"
.Vb 1
\&  #<guard>
.Ve
.IP "\fBTeX\fR" 4
.IX Item "TeX"
.Vb 1
\&  %<guard>
.Ve
.RE
.RS 4
.Sp
The pattern names should be separated by commas, and the list may be
enclosed in quotes to prevent shell expansion, e.g
.Sp
.Vb 1
\&  \-c "TeX, c, shell"
.Ve
.RE
.IP "\fB\-d\fR" 4
.IX Item "-d"
Debug mode on.
.IP "\fB\-e\fR \fIaudience\fR" 4
.IX Item "-e audience"
Extract the contents for the current audience into the file \fIfile\fR.
The cuurent audience is guessed from the \fIfile\fR name, if the latter
has the structure \fIbase\fR\-\fIaudience\fR.\fIextension\fR,
e.g. \f(CW\*(C`report\-unclassified.tex\*(C'\fR.  The key \fB\-a\fR overrides this guess
and should be used if the file name does not follow this pattern.  The
file name \f(CW\*(C`\-\*(C'\fR means the standard output.
.IP "\fB\-h\fR" 4
.IX Item "-h"
Print help information and exit.
.IP "\fB\-l\fR" 4
.IX Item "-l"
List all audiences set in the file (one per line) and exit.
.IP "\fB\-u\fR \fIaudience\fR" 4
.IX Item "-u audience"
Take a edited file intended for the \fIaudience\fR (the second
non-option argument) and incorporate the changes in it into the full
file (the first non-option argument).  If the second argument is
missing, standard input is used instead.  As usual, \f(CW\*(C`\-\*(C'\fR also means
standard input.  Note that only one of the two file arguments in this
case can be standard input.
.IP "\fB\-v\fR" 4
.IX Item "-v"
Print version information and exit.
.IP "\fB\-w\fR \fIon|off|1|0|true|false\fR" 4
.IX Item "-w on|off|1|0|true|false"
If \f(CW\*(C`on\*(C'\fR, \f(CW1\fR or \f(CW\*(C`true\*(C'\fR (the deafult), implicitly wrap the full
document into the guards
.Sp
.Vb 3
\& %<*ALL>
\& ...
\& %</ALL>
.Ve
.SH "RETURN VALUE"
.IX Header "RETURN VALUE"
The program returns 0 if successful, 1 if conflicts were found in the
\&\f(CW\*(C`unextract\*(C'\fR mode and 2 in case of problems.
.SH "CONFLICTS IN UNEXTRACT MODE"
.IX Header "CONFLICTS IN UNEXTRACT MODE"
Like the standard \fIdiff3\fR\|(1) tool, the program may find conflicts
between the full version and the edited one in the \fB\-u\fR mode.  Then
the resulting file brackets the conflicts in the usual manner, e.g.
.PP
.Vb 10
\&  <<<<<<< /tmp/BrjXo0hMOB/full
\&  %</nobonds>
\&  Forty\-five tons best old dry government bonds, suitable for furnace, gold
\&  7 per cents., 1864, preferred.
\&  %<*nobonds>
\&  ||||||| /tmp/BrjXo0hMOB/extracted
\&  Forty\-five tons best old dry government bonds, suitable for furnace, gold
\&  7 per cents., 1864, preferred.
\&  =======
\&  >>>>>>> /tmp/BrjXo0hMOB/new
.Ve
.PP
Here \f(CW\*(C`full\*(C'\fR is the full document, \f(CW\*(C`extracted\*(C'\fR is the extracted file
for the given audience, \f(CW\*(C`new\*(C'\fR is the edited file.
.SH "AUTHOR"
.IX Header "AUTHOR"
Boris Veytsman, borisv@lk.net
.PP
This work was commissioned by Consumer Financial Protection Bureau,
United States Treasury.
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright (C) 2015 Boris Veytsman.  Version 1.0
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the \s-1GNU\s0 General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at
your option) any later version.
.PP
This program is distributed in the hope that it will be useful, but
\&\s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0.  See the \s-1GNU\s0
General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, \s-1MA\s0
02110\-1301, \s-1USA\s0