[apple/security.git] / SecuritySNACCRuntime / doc / snacced.1

'\" This manual page, except for the introductory troff macros, is
'\" Copyright (c) 1995 by Robert Joop.
'\" 
'\" $Header: /cvs/root/Security/SecuritySNACCRuntime/doc/Attic/snacced.1,v 1.1.1.1 2001/05/18 23:14:10 mb Exp $
'\" $Log: snacced.1,v $
'\" Revision 1.1.1.1  2001/05/18 23:14:10  mb
'\" Move from private repository to open source repository
'\"
'\" Revision 1.1.1.1  1999/03/16 18:05:54  aram
'\" Originals from SMIME Free Library.
'\"
'\" Revision 1.1  1997/01/01 22:47:21  rj
'\" first check-in
'\"
'\"
'\" Copyright (c) 1993 The Regents of the University of California.
'\" All rights reserved.
'\"
'\" Permission is hereby granted, without written agreement and without
'\" license or royalty fees, to use, copy, modify, and distribute this
'\" documentation for any purpose, provided that the above copyright
'\" notice and the following two paragraphs appear in all copies.
'\"
'\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
'\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
'\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
'\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
'\"
'\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
'\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
'\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
'\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
'\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
'\" 
.\" The definitions below are for supplemental macros used in Tcl/Tk
.\" manual entries.
.\"
.\" .HS name section [date [version]]
.\"	Replacement for .TH in other man pages.  See below for valid
.\"	section names.
.\"
.\" .AP type name in/out [indent]
.\"	Start paragraph describing an argument to a library procedure.
.\"	type is type of argument (int, etc.), in/out is either "in", "out",
.\"	or "in/out" to describe whether procedure reads or modifies arg,
.\"	and indent is equivalent to second arg of .IP (shouldn't ever be
.\"	needed;  use .AS below instead)
.\"
.\" .AS [type [name]]
.\"	Give maximum sizes of arguments for setting tab stops.  Type and
.\"	name are examples of largest possible arguments that will be passed
.\"	to .AP later.  If args are omitted, default tab stops are used.
.\"
.\" .BS
.\"	Start box enclosure.  From here until next .BE, everything will be
.\"	enclosed in one large box.
.\"
.\" .BE
.\"	End of box enclosure.
.\"
.\" .VS
.\"	Begin vertical sidebar, for use in marking newly-changed parts
.\"	of man pages.
.\"
.\" .VE
.\"	End of vertical sidebar.
.\"
.\" .DS
.\"	Begin an indented unfilled display.
.\"
.\" .DE
.\"	End of indented unfilled display.
.\"
'\"	# Heading for Tcl/Tk man pages
.de HS
.ds ^3 \\0
.if !"\\$3"" .ds ^3 \\$3
.if '\\$2'cmds'       .TH \\$1 1 \\*(^3 \\$4
.if '\\$2'lib'        .TH \\$1 3 \\*(^3 \\$4
.if '\\$2'tcl'        .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
.if '\\$2'tk'         .TH \\$1 n \\*(^3 Tk "Tk Commands"
.if '\\$2'tclc'        .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
.if '\\$2'tkc'         .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
.if '\\$2'tclcmds'         .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
.if '\\$2'tkcmds'         .TH \\$1 1 \\*(^3 Tk "Tk Applications"
.if t .wh -1.3i ^B
.nr ^l \\n(.l
.ad b
..
'\"	# Start an argument description
.de AP
.ie !"\\$4"" .TP \\$4
.el \{\
.   ie !"\\$2"" .TP \\n()Cu
.   el          .TP 15
.\}
.ie !"\\$3"" \{\
.ta \\n()Au \\n()Bu
\&\\$1	\\fI\\$2\\fP	(\\$3)
.\".b
.\}
.el \{\
.br
.ie !"\\$2"" \{\
\&\\$1	\\fI\\$2\\fP
.\}
.el \{\
\&\\fI\\$1\\fP
.\}
.\}
..
'\"	# define tabbing values for .AP
.de AS
.nr )A 10n
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.nr )B \\n()Au+15n
.\"
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
..
'\"	# BS - start boxed text
'\"	# ^y = starting y location
'\"	# ^b = 1
.de BS
.br
.mk ^y
.nr ^b 1u
.if n .nf
.if n .ti 0
.if n \l'\\n(.lu\(ul'
.if n .fi
..
'\"	# BE - end boxed text (draw box now)
.de BE
.nf
.ti 0
.mk ^t
.ie n \l'\\n(^lu\(ul'
.el \{\
.\"	Draw four-sided box normally, but don't draw top of
.\"	box if the box started on an earlier page.
.ie !\\n(^b-1 \{\
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.el \}\
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.\}
.fi
.br
.nr ^b 0
..
'\"	# VS - start vertical sidebar
'\"	# ^Y = starting y location
'\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
.de VS
.mk ^Y
.ie n 'mc \s12\(br\s0
.el .nr ^v 1u
..
'\"	# VE - end of vertical sidebar
.de VE
.ie n 'mc
.el \{\
.ev 2
.nf
.ti 0
.mk ^t
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
.sp -1
.fi
.ev
.\}
.nr ^v 0
..
'\"	# Special macro to handle page bottom:  finish off current
'\"	# box/sidebar if in box/sidebar mode, then invoked standard
'\"	# page bottom macro.
.de ^B
.ev 2
'ti 0
'nf
.mk ^t
.if \\n(^b \{\
.\"	Draw three-sided box if this is the box's first page,
.\"	draw two sides but no top otherwise.
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.\}
.if \\n(^v \{\
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
.\}
.bp
'fi
.ev
.if \\n(^b \{\
.mk ^y
.nr ^b 2
.\}
.if \\n(^v \{\
.mk ^Y
.\}
..
'\"	# DS - begin display
.de DS
.RS
.nf
.sp
..
'\"	# DE - end display
.de DE
.fi
.RE
.sp .5
..
.TH snacced 1 "August 1995" Tk "Tk Applications"
.BS
'\" Note:  do not modify the .SH NAME line immediately below!
.SH NAME
snacced \- Graphical editor for BER encoded ASN.1 files
.SH SYNOPSIS
\fBsnacced \fIoption\fR ?\fImodule type file\fR?
.BE

.SH DESCRIPTION
.PP
This command allowes to browse and edit BER encoded files.

The snacced script needs to be executed by a snaccwish, a Tk shell (see \fIwish\fP(1))
with additional snacc functionality (see \fIsnacc\fP(n)).

For directions on how to build the snaccwish, please refer to the
snacc documentation.
.SH ARGUMENTS
.TP
\fBsnacced \fImodule type file\fR
Open \fIfile\fP that has to be an instance of type \fItype\fP in the ASN.1 module \fImodule\fP.
.TP
\fBsnacced \fImodule type\fR
Create an instance of the given type.
.TP
\fBsnacced\fR
Called without arguments, pops up a file and type selection box.
.SH SEE ALSO
.IR wish (1), snacc (n)
.SH KEYWORDS
ASN.1, BER, snaccwish, snacc, editor, file
Commit	Line	Data
bac41a7b A	1	'\" This manual page, except for the introductory troff macros, is
	2	'\" Copyright (c) 1995 by Robert Joop.
	3	'\"
a66d0d4a	4	'\" $Header: /cvs/root/Security/SecuritySNACCRuntime/doc/Attic/snacced.1,v 1.1.1.1 2001/05/18 23:14:10 mb Exp $
bac41a7b A	5	'\" $Log: snacced.1,v $
	6	'\" Revision 1.1.1.1 2001/05/18 23:14:10 mb
	7	'\" Move from private repository to open source repository
	8	'\"
	9	'\" Revision 1.1.1.1 1999/03/16 18:05:54 aram
	10	'\" Originals from SMIME Free Library.
	11	'\"
	12	'\" Revision 1.1 1997/01/01 22:47:21 rj
	13	'\" first check-in
	14	'\"
	15	'\"
	16	'\" Copyright (c) 1993 The Regents of the University of California.
	17	'\" All rights reserved.
	18	'\"
	19	'\" Permission is hereby granted, without written agreement and without
	20	'\" license or royalty fees, to use, copy, modify, and distribute this
	21	'\" documentation for any purpose, provided that the above copyright
	22	'\" notice and the following two paragraphs appear in all copies.
	23	'\"
	24	'\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
	25	'\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
	26	'\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
	27	'\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	28	'\"
	29	'\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
	30	'\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
	31	'\" AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
	32	'\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
	33	'\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
	34	'\"
	35	.\" The definitions below are for supplemental macros used in Tcl/Tk
	36	.\" manual entries.
	37	.\"
	38	.\" .HS name section [date [version]]
	39	.\" Replacement for .TH in other man pages. See below for valid
	40	.\" section names.
	41	.\"
	42	.\" .AP type name in/out [indent]
	43	.\" Start paragraph describing an argument to a library procedure.
	44	.\" type is type of argument (int, etc.), in/out is either "in", "out",
	45	.\" or "in/out" to describe whether procedure reads or modifies arg,
	46	.\" and indent is equivalent to second arg of .IP (shouldn't ever be
	47	.\" needed; use .AS below instead)
	48	.\"
	49	.\" .AS [type [name]]
	50	.\" Give maximum sizes of arguments for setting tab stops. Type and
	51	.\" name are examples of largest possible arguments that will be passed
	52	.\" to .AP later. If args are omitted, default tab stops are used.
	53	.\"
	54	.\" .BS
	55	.\" Start box enclosure. From here until next .BE, everything will be
	56	.\" enclosed in one large box.
	57	.\"
	58	.\" .BE
	59	.\" End of box enclosure.
	60	.\"
	61	.\" .VS
	62	.\" Begin vertical sidebar, for use in marking newly-changed parts
	63	.\" of man pages.
	64	.\"
	65	.\" .VE
	66	.\" End of vertical sidebar.
	67	.\"
	68	.\" .DS
69	.\" Begin an indented unfilled display.
70	.\"
71	.\" .DE
72	.\" End of indented unfilled display.
73	.\"
74	'\" # Heading for Tcl/Tk man pages
75	.de HS
76	.ds ^3 \\0
77	.if !"\\$3"" .ds ^3 \\$3
78	.if '\\$2'cmds' .TH \\$1 1 \\*(^3 \\$4
79	.if '\\$2'lib' .TH \\$1 3 \\*(^3 \\$4
80	.if '\\$2'tcl' .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
81	.if '\\$2'tk' .TH \\$1 n \\*(^3 Tk "Tk Commands"
82	.if '\\$2'tclc' .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
83	.if '\\$2'tkc' .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
84	.if '\\$2'tclcmds' .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
85	.if '\\$2'tkcmds' .TH \\$1 1 \\*(^3 Tk "Tk Applications"
86	.if t .wh -1.3i ^B
87	.nr ^l \\n(.l
88	.ad b
89	..
90	'\" # Start an argument description
91	.de AP
92	.ie !"\\$4"" .TP \\$4
93	.el \{\
94	. ie !"\\$2"" .TP \\n()Cu
95	. el .TP 15
96	.\}
97	.ie !"\\$3"" \{\
98	.ta \\n()Au \\n()Bu
99	\&\\$1 \\fI\\$2\\fP (\\$3)
100	.\".b
101	.\}
102	.el \{\
103	.br
104	.ie !"\\$2"" \{\
105	\&\\$1 \\fI\\$2\\fP
106	.\}
107	.el \{\
108	\&\\fI\\$1\\fP
109	.\}
110	.\}
111	..
112	'\" # define tabbing values for .AP
113	.de AS
114	.nr )A 10n
115	.if !"\\$1"" .nr )A \\w'\\$1'u+3n
116	.nr )B \\n()Au+15n
117	.\"
118	.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
119	.nr )C \\n()Bu+\\w'(in/out)'u+2n
120	..
121	'\" # BS - start boxed text
122	'\" # ^y = starting y location
123	'\" # ^b = 1
124	.de BS
125	.br
126	.mk ^y
127	.nr ^b 1u
128	.if n .nf
129	.if n .ti 0
130	.if n \l'\\n(.lu\(ul'
131	.if n .fi
132	..
133	'\" # BE - end boxed text (draw box now)
134	.de BE
135	.nf
136	.ti 0
137	.mk ^t
138	.ie n \l'\\n(^lu\(ul'
139	.el \{\
140	.\" Draw four-sided box normally, but don't draw top of
141	.\" box if the box started on an earlier page.
142	.ie !\\n(^b-1 \{\
143	\h'-1.5n'\L'\|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
144	.\}
145	.el \}\
146	\h'-1.5n'\L'\|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
147	.\}
148	.\}
149	.fi
150	.br
151	.nr ^b 0
152	..
153	'\" # VS - start vertical sidebar
154	'\" # ^Y = starting y location
155	'\" # ^v = 1 (for troff; for nroff this doesn't matter)
156	.de VS
157	.mk ^Y
158	.ie n 'mc \s12\(br\s0
159	.el .nr ^v 1u
160	..
161	'\" # VE - end of vertical sidebar
162	.de VE
163	.ie n 'mc
164	.el \{\
165	.ev 2
166	.nf
167	.ti 0
168	.mk ^t
169	\h'\|\\n(^lu+3n'\L'\|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-\|\\n(^lu+3n'
170	.sp -1
171	.fi
172	.ev
173	.\}
174	.nr ^v 0
175	..
176	'\" # Special macro to handle page bottom: finish off current
177	'\" # box/sidebar if in box/sidebar mode, then invoked standard
178	'\" # page bottom macro.
179	.de ^B
180	.ev 2
181	'ti 0
182	'nf
183	.mk ^t
184	.if \\n(^b \{\
185	.\" Draw three-sided box if this is the box's first page,
186	.\" draw two sides but no top otherwise.
187	.ie !\\n(^b-1 \h'-1.5n'\L'\|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'\|0u'\c
188	.el \h'-1.5n'\L'\|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'\|0u'\c
189	.\}
190	.if \\n(^v \{\
191	.nr ^x \\n(^tu+1v-\\n(^Yu
192	\kx\h'-\\nxu'\h'\|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'\|0u'\c
193	.\}
194	.bp
195	'fi
196	.ev
197	.if \\n(^b \{\
198	.mk ^y
199	.nr ^b 2
200	.\}
201	.if \\n(^v \{\
202	.mk ^Y
203	.\}
204	..
205	'\" # DS - begin display
206	.de DS
207	.RS
208	.nf
209	.sp
210	..
211	'\" # DE - end display
212	.de DE
213	.fi
214	.RE
215	.sp .5
216	..
217	.TH snacced 1 "August 1995" Tk "Tk Applications"
218	.BS
219	'\" Note: do not modify the .SH NAME line immediately below!
220	.SH NAME
221	snacced \- Graphical editor for BER encoded ASN.1 files
222	.SH SYNOPSIS
223	\fBsnacced \fIoption\fR ?\fImodule type file\fR?
224	.BE
225
226	.SH DESCRIPTION
227	.PP
228	This command allowes to browse and edit BER encoded files.
229
230	The snacced script needs to be executed by a snaccwish, a Tk shell (see \fIwish\fP(1))
231	with additional snacc functionality (see \fIsnacc\fP(n)).
232
233	For directions on how to build the snaccwish, please refer to the
234	snacc documentation.
235	.SH ARGUMENTS
236	.TP
237	\fBsnacced \fImodule type file\fR
238	Open \fIfile\fP that has to be an instance of type \fItype\fP in the ASN.1 module \fImodule\fP.
239	.TP
240	\fBsnacced \fImodule type\fR
241	Create an instance of the given type.
242	.TP
243	\fBsnacced\fR
244	Called without arguments, pops up a file and type selection box.
245	.SH SEE ALSO
246	.IR wish (1), snacc (n)
247	.SH KEYWORDS
248	ASN.1, BER, snaccwish, snacc, editor, file