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 .** sane default for everything except rst
  36 .dv col_width 6.5i
  37
  38 .** CAUTION:  xfm comparisons are reverse polish so  "a b ="  is true if a == b.
  39 .if pfm
  40         .im &{lib}/generic_ps.im
  41 .ei
  42         .gv e OUTPUT_TYPE ot
  43
  44         .if "&ot" "txt" =
  45                 .im &{lib}/txt.im
  46         .fi
  47         .if "&ot" "rst" =
  48                 .** bleeding rst needs bullet lists to have no line breaks
  49                 .dv col_width 20i
  50                 .im &{lib}/rst.im
  51         .fi
  52         .if "&ot" "markdown" =
  53                 .im &{lib}/markdown.im
  54         .fi
  55         .if "&ot" "troff" =
  56                 .im &{lib}/roff.im
  57         .fi
  58 .fi
  59
  60 .** set up for an index when using pfm and snare file is defined
  61 .if pfm
  62         .if index_snare_file
  63                 .ix space .sp 1 .cc 5 %c .ln  ^: .sp 0
  64                 .ix term .br %s  `^`   ^`` %d
  65                 .ix groupb .sp .5 %s .br .ll -.25i .in +.25i
  66                 .ix groupe .sp .1 .in -.25i .ll +.25i
  67                 .if ! index_cols
  68                         .dv index_cols 2
  69                 .fi
  70
  71                 .dv index_col_width [ 6.5 &index_cols / .25 &index_cols 1 - * - ]
  72                 .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
  73                 .im &index_snare_file
  74         .fi
  75 .fi
  76
  77