Fix header levels in some .dbd.pod files

This commit is contained in:
Andrew Johnson
2025-06-18 11:12:43 -05:00
parent 9eca4bc448
commit 99682610a0
5 changed files with 60 additions and 46 deletions
+6 -6
View File
@@ -7,7 +7,7 @@
# in file LICENSE that is included with this distribution.
#*************************************************************************
=head3 Operator Display Parameters
=head2 Operator Display Parameters
The B<NAME> field contains the record name which must be unique within an
EPICS Channel Access name space. The name is supplied by the application
@@ -43,7 +43,7 @@ record's purpose. Maximum length is 40 characters.
size(29)
}
=head3 Scan Fields
=head2 Scan Fields
These fields contain information related to how and when a record processes. A
few records have unique fields that also affect how they process. These
@@ -244,7 +244,7 @@ The B<SPVT> field is for internal use by the scanning system.
interest(3)
}
=head3 Alarm Fields
=head2 Alarm Fields
Alarm fields indicate the status and severity of record alarms, or determine
how and when alarms are triggered. Of course, many records have alarm-related
@@ -391,7 +391,7 @@ initial severity of the record being undefined after the IOC boots.
extra("struct scan_element *spvt")
}
=head3 Device Fields
=head2 Device Fields
The B<RSET> field contains the address of the Record Support Entry Table. See
the Application Developers Guide for details on usage.
@@ -445,7 +445,7 @@ The B<DPVT> field is is for private use of the device support modules.
menu(menuPriority)
}
=head3 Debugging Fields
=head2 Debugging Fields
The B<TPRO> field can be used to trace record processing. When this field is
non-zero and the record is processed, a trace message will be be printed for
@@ -460,7 +460,7 @@ database processing can be supported using this.
=fields TPRO, BKPT
=head3 Miscellaneous Fields
=head2 Miscellaneous Fields
The B<ASG> string field sets the name of the access security group used for this
record. If left empty, the record is placed in group C<DEFAULT>.
@@ -11,7 +11,7 @@ These fields usually have the same meaning whenever they are used.
See also L<Fields Common to All Record Types|dbCommonRecord> and L<Fields Common
to Output Record Types|dbCommonOutput>.
=head3 Input and Value Fields
=head2 Input and Value Fields
The B<INP> field specifies an input link. It is used by the device support
routines to obtain input. For soft analog records it can be a constant, a
@@ -30,7 +30,7 @@ reads values directly into VAL, bypassing this field.
The B<VAL> field contains the record's final value, after any needed
conversions have been performed.
=head3 Device Input
=head2 Device Input
A device input routine normally returns one of the following values to its
associated record support routine:
@@ -65,7 +65,7 @@ to the engineering units value.
=back
=head3 Device Support for Soft Records
=head2 Device Support for Soft Records
In most cases, two soft output device support modules are provided: Soft Channel
and Raw Soft Channel. Both allow INP to be a constant, a database link, or a
@@ -83,7 +83,7 @@ If a value was returned by the link the UDF field is set to FALSE. The device
support read routine normally returns the status from C<dbGetLink()>.
=head3 Input Simulation Fields
=head2 Input Simulation Fields
The B<SIMM> field controls simulation mode.
By setting this field to YES or RAW, the record can be switched into
@@ -121,7 +121,7 @@ The B<SSCN> field specifies the SCAN mechanism to be used in simulation mode.
This is specifically useful for 'I/O Intr' scanned records, which would
otherwise never be scanned in simulation mode.
=head3 Simulation Mode for Input Records
=head2 Simulation Mode for Input Records
An input record can be switched into simulation mode of operation by setting
the value of SIMM to YES or RAW.
@@ -11,7 +11,7 @@ These fields usually have the same meaning whenever they are used.
See also L<Fields Common to All Record Types|dbCommonRecord> and L<Fields Common to
Input Records|dbCommonInput>.
=head3 Output and Value Fields
=head2 Output and Value Fields
The B<OUT> field specifies an output link. It is used by the device support
routines to decide where to send output. For soft records, it can be a
@@ -38,7 +38,7 @@ The B<RBV> field contains - whenever possible - the actual read back value
obtained from the hardware itself or from the associated device driver.
=head3 Device Support for Soft Records
=head2 Device Support for Soft Records
Normally two soft output device support modules are provided, Soft Channel and
and Raw Soft Channel. Both write a value through the output link OUT.
@@ -50,7 +50,7 @@ The device support write routine normally calls C<dbPutLink()> which writes a
value through the OUT link, and returns the status from that call.
=head3 Input and Mode Select Fields
=head2 Input and Mode Select Fields
The B<DOL> field is a link from which the desired output value can be fetched.
DOL can be a constant, a database link, or a channel access link. If DOL is a
@@ -63,7 +63,7 @@ value C<closed_loop>. By setting this field a record can be switched between
supervisory and closed loop mode of operation. While in closed loop mode, the
VAL field cannot be set via dbPuts.
=head3 Output Mode Selection
=head2 Output Mode Selection
The fields DOL and OMSL are used to allow the output record to be part of a
closed loop control algorithm. OMSL is meaningful only if DOL refers to a
@@ -76,7 +76,7 @@ types with an OIF field and OIF is Full, VAL is set equal to the value obtained
from the location referenced by DOL; if OIF is Incremental VAL is incremented by
the value obtained from DOL.
=head3 Invalid Output Action Fields
=head2 Invalid Output Action Fields
The B<IVOA> field specifies the output action for the case that the record is
put into an INVALID alarm severity. IVOA can be one of the following actions:
@@ -102,7 +102,7 @@ in engineering units. If a new severity has been set to INVALID and IVOA is
C<Set output to IVOV>, then VAL is set to IVOV and converted to RVAL before
device support is called.
=head3 Invalid Alarm Output Action
=head2 Invalid Alarm Output Action
Whenever an output record is put into INVALID alarm severity, IVOA specifies
an action to take. The record support process routine for each output record
@@ -142,7 +142,7 @@ If IVOA not one of the above, an error message is generated.
=back
=head3 Output Simulation Fields
=head2 Output Simulation Fields
The B<SIMM> field controls simulation mode. It has either the value YES or NO.
By setting this field to YES, the record can be switched into simulation mode
@@ -171,7 +171,7 @@ The B<SSCN> field specifies the SCAN mechanism to be used in simulation mode.
This is specifically useful for 'I/O Intr' scanned records, which would
otherwise never be scanned in simulation mode.
=head3 Simulation Mode for Output Records
=head2 Simulation Mode for Output Records
An output record can be switched into simulation mode of operation by setting
the value of SIMM to YES. During simulation, the record will be put into alarm
@@ -8,8 +8,8 @@
This section contains a description of the fields that are common to all record
types. These fields are defined in dbCommon.dbd.
See also L<Fields Common to Input Record Types|dbCommonInput> and L<Fields
Common to Output Record Types|dbCommonOutput>.
See also L<Fields Common to Input Record Types|dbCommonInput> and
L<Fields Common to Output Record Types|dbCommonOutput>.
=recordtype dbCommon