Add user guide

[ric-plt/xapp-frame-cpp.git] / doc / src / lib / generic_ps.im

diff --git a/doc/src/lib/generic_ps.im b/doc/src/lib/generic_ps.im
new file mode 100644 (file)
index 0000000..bea4598
--- /dev/null
+++ b/doc/src/lib/generic_ps.im
@@ -0,0 +1,102 @@
+.if false
+==================================================================================
+       Copyright (c) 2020 Nokia
+       Copyright (c) 2020 AT&T Intellectual Property.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+==================================================================================
+.fi
+
+.** macros compatable with the roff/troff and rts imbed files
+.** this is included when generating postscript from the man source.
+
+       .dv esc : .** rst needs an escape for some things
+
+       .hn off
+       .dv text_size 10p
+       .dv ex_size 8p
+       .dv text_font Helvetica
+       .dv ital_font Helvetica-Oblique
+       .dv bold_font Helvetica-Bold
+       .dv cw_font  Courier
+       .st &text_size
+       .sf &text_font
+       .dh 1 f=&bold_font p=12 e=no s=2,1 m=.5i i=0i
+       .dh 2 f=&bold_font p=10 s=1,.5 m=.5i i=0i
+       .dh 3 f=&bold_font p=10 s=1,0 m=.5i i=0i
+
+       .dv comment .** ignore
+
+       .dv h1 .h1 $1
+       .dv h2 .h2 $1
+       .dv h3 .h3 $1
+
+       .dv fig
+       .dv set_font_cw .sf ^&cw_font
+
+       .dv nf .nf
+       .dv fo .fo
+
+       .dv center_start .bc start
+       .dv center_end .bc end
+
+       .dv line_len .ll $1 .dv cn_line_len $1 ^:
+       .dv space .sp 1
+       .dv mult_space .sp $1
+       .dv half_space .sp .5
+
+       .dv beg_list .bl $1
+       .dv end_list .el
+       .dv lic1 n
+       .dv lic2 m
+       .dv lic3 l
+
+       .dv figure .fg x=center $1
+
+       .dv beg_dlist .bd $1 $2
+       .dv end_dlist .ed
+       .dv ditem .cc 2 .sp .5 .di $1 ^:
+       .dv di .cc 2 .sp .5 .di $1 ^:
+       .dv li .cc 2 .sp .5 .li
+       .dv item .cc 2 .li
+
+       .dv proto_start .sp 1 .cc .5i .st 9 .sf Courier-bold .nf
+       .dv proto_end .fo on .sf ^&text_font .st ^&text_size .sp .3
+
+       .dv ex_start .sp .5 .st ^&ex_size .sf ^&cw_font .nf
+       .dv ex_end .fo on .sf ^&text_font .st ^&text_size .sp 1
+
+       .dv fo_ex_start .sp .5 .st ^&ex_size .sf ^&cw_font
+       .dv fo_ex_end .sf ^&text_font .st ^&text_size .sp 1
+
+       .** fonts and font macros
+       .dv ital .tf ^&ital_font ^&text_size $1 ^:
+       .dv bold .tf ^&bold_font ^&text_size $1 ^:
+       .dv cw .tf ^&cw_font ^&text_size $1 ^:
+       .dv set_font_prop .sf ^&text_font
+
+       .cd 1 6.0i
+       .ll 6i
+       .pn off
+       .ju on
+       .in .5i
+       .dv cn_indent .5i
+       .dv cn_line_len 6i
+
+       .dv indent .ll -0.5i .in +0.25i
+       .dv uindent .in -0.25i .ll +0.5i
+
+       .dv super .sm ^[ .sm ^&{ss_num}]
+       .dv ss_num 1
+       .dv note .dv ss_num ^[ ?%.0f ^&ss_num 1 + ] ^: .sm .tf superscript /2 ^&{ss_num} ^:
+       .dv atbot atbot