Add user manual source
[ric-plt/lib/rmr.git] / doc / src / library / setup.im
1 .if false
2 ==================================================================================
3         Copyright (c) 2019 Nokia
4         Copyright (c) 2018-2019 AT&T Intellectual Property.
5
6    Licensed under the Apache License, Version 2.0 (the "License");
7    you may not use this file except in compliance with the License.
8    You may obtain a copy of the License at
9
10        http://www.apache.org/licenses/LICENSE-2.0
11
12    Unless required by applicable law or agreed to in writing, software
13    distributed under the License is distributed on an "AS IS" BASIS,
14    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15    See the License for the specific language governing permissions and
16    limitations under the License.
17 ==================================================================================
18 .fi
19
20 .if false
21         Mnemonic:       setup.im
22         Abstract:       Look at environment variables and pull in the correct setup prep
23                                 imbed file based on the desired output type (when running tfm).
24                                 Obviously, when running pfm we are always generating postscript
25                                 so this isn't really doing much.
26         Date:           29 July 2019
27 .fi
28
29
30 .gv e LIB lib
31 .if ! lib
32         .dv lib ..
33 .fi
34
35 .** CAUTION:  xfm comparisons are reverse polish so  "a b ="  is true if a == b.
36 .if pfm
37         .im &{lib}/generic_ps.im
38 .ei
39         .gv e OUTPUT_TYPE ot
40
41         .if "&ot" "txt" =
42                 .im &{lib}/txt.im
43         .fi
44         .if "&ot" "rst" =
45                 .im &{lib}/rst.im
46         .fi
47         .if "&ot" "markdown" =
48                 .im &{lib}/markdown.im
49         .fi
50         .if "&ot" "troff" =
51                 .im &{lib}/roff.im
52         .fi
53 .fi
54
55 .** set up for an index when using pfm and snare file is defined
56 .if pfm
57         .if index_snare_file
58                 .ix space .sp 1 .cc 5 %c .ln  ^: .sp 0
59                 .ix term .br %s  `^`   ^`` %d
60                 .ix groupb .sp .5 %s .br .ll -.25i .in +.25i
61                 .ix groupe .sp .1 .in -.25i .ll +.25i
62                 .if ! index_cols
63                         .dv index_cols 2
64                 .fi
65
66                 .dv index_col_width [ 6.5 &index_cols / .25 &index_cols 1 - * - ]
67                 .dv index_here  .pa .ju off .st &textsize .cd 1 i=1i w=7 ^: .h1 INDEX ^: .pn off .lw 0 .sp 0 .tt ^: .cd &index_cols i=1i w=&{index_col_width}i  g=.25i ^: .in -i .ll &{index_col_width}i .ix insert
68                 .im &index_snare_file
69         .fi
70 .fi
71
72