Files
magic/doc/html/ruler.html
T
Tim Edwards 09577b5636 Updated all of the documentation by copying back from the website.
The website documentation now points to these contents in a clone
of the repository on opencircuitdesign.com, so all future edits of
the command-line documentation will be made directly to the git
repository.  Also:  Changed the precision of box values printed in
microns from 2 to 3 digits after the decimal place, so that 5 nanometer
grids do not get values clipped in the output.
2022-01-21 10:44:13 -05:00

72 lines
2.2 KiB
HTML

<HTML>
<HEAD>
<STYLE type="text/css">
H1 {color: black }
H2 {color: maroon }
H3 {color: #007090 }
A.head:link {color: #0060a0 }
A.head:visited {color: #3040c0 }
A.head:active {color: white }
A.head:hover {color: yellow }
A.red:link {color: red }
A.red:visited {color: maroon }
A.red:active {color: yellow }
</STYLE>
</HEAD>
<TITLE>Magic-7.3 Command Reference</TITLE>
<BODY BACKGROUND=graphics/blpaper.gif>
<H1> <IMG SRC=graphics/magic_title8_2.png ALT="Magic VLSI Layout Tool Version 8.2">
<IMG SRC=graphics/magic_OGL_sm.gif ALIGN="top" ALT="*"> </H1>
<H2>ruler</H2>
<HR>
Create ruler markings inside the box with indicated text.
<HR>
<H3>Usage:</H3>
<BLOCKQUOTE>
<B>ruler</B> [<I>text</I> [<I>orient</I>]] <BR><BR>
<BLOCKQUOTE>
where <I>orient</I> is either <B>vertical</B>,
<B>horizontal</B>, or <B>auto</B> (the default), and
where <I>text</I> is any string. If the string
contains whitespace, it must be quoted.
</BLOCKQUOTE>
</BLOCKQUOTE>
<H3>Summary:</H3>
<BLOCKQUOTE>
The <B>ruler</B> command generates a "ruler", a set of lines indicating
a dimension. It is used to annotate layouts with the indicated text.
If no orientation is given, then automatic orientation it used, in
which the presented dimension (the line or lines with arrowheads)
is whichever box dimension (width or height) is longer. The ruler
may be removed with the <B>unmeasure</B> command. The <B>measure</B>
command is a specific type of ruler where the text is set to the
presented box dimension.
</BLOCKQUOTE>
<H3>Implementation Notes:</H3>
<BLOCKQUOTE>
<B>ruler</B> is implemented as a Tcl procedure defined
in the "tools" script. It generates a set of elements (lines and
text) with the <B>element add</B> command.
</BLOCKQUOTE>
<H3>See Also:</H3>
<BLOCKQUOTE>
<A HREF=measure.html><B>measure</B></A> <BR>
<A HREF=unmeasure.html><B>unmeasure</B></A> <BR>
</BLOCKQUOTE>
<P><IMG SRC=graphics/line1.gif><P>
<TABLE BORDER=0>
<TR>
<TD> <A HREF=commands.html>Return to command index</A>
</TR>
</TABLE>
<P><I>Last updated:</I> March 7, 2020 at 1:06pm <P>
</BODY>
</HTML>