Understand Documentation - und Reference
scitools.com

← Settings Reference

und is the command-line interface to Understand — script project creation, analysis, CodeCheck, metrics, and reports, locally or in CI.

Run Understand from the command line · Headless workflow: create, analyze, check, report

und Settings Examples

A real, working und settings command for each setting that has discrete options, grouped by language. Every example was run against a project and accepted by the tool; myProject.und is a stand-in database name.

Setting several options in one command

A single und settings call can set as many options as you like — just list each switch and its value. Each command below was validated as a whole.

What it doesCommand
Several general options at onceund settings -DependencyExcludeStandard On -DependencyUseIncludes On -DependencyMode Compile myProject.und
Tune the C/C++ analysisund settings -C++UseStrict On -C++CreateUniqueEntitiesForObjectDataMembers On -C++CreateUniqueEntitiesForObjectFunctionMembers On -C++CreateReferencesInInactiveCode On myProject.und
Enable a set of metricsund settings -MetricWriteColumnTitles On -MetricAddUniqueNameColumn On -MetricShowFunctionParameterTypes On -MetricShowDeclaredInFile On myProject.und
General, metric, and C/C++ options togetherund settings -DependencyExcludeStandard On -DependencyUseIncludes On -MetricWriteColumnTitles On -C++UseStrict On myProject.und

A typical command-line workflow

Create a project, add sources, tune the analysis, parse, run CodeCheck, and generate reports — as you might in a CI job. The settings options below were validated by the tool; the paths are stand-ins.

und create -db myProject.und -languages c++
und add -db myProject.und ./src
und settings -C++UseStrict On -C++CreateUniqueEntitiesForObjectDataMembers On -MetricWriteColumnTitles On myProject.und
und analyze -db myProject.und
und codecheck -gitfiles MyConfig myProject.und ./codecheck_out
und report myProject.und

General Settings

SettingOptionsExample
DependencyExcludeStandardOn/Offund settings -DependencyExcludeStandard On myProject.und
DependencyUseIncludesOn/Offund settings -DependencyUseIncludes On myProject.und
DependencyModeCompile/Linkund settings -DependencyMode Compile myProject.und
OpenFilesAsReadOnlyOn/Offund settings -OpenFilesAsReadOnly On myProject.und
EnforcePortabilityOn/Offund settings -EnforcePortability On myProject.und
MaxFileSizeParsed2-150 MBund settings -MaxFileSizeParsed 2 myProject.und
FileEncodingUTF-8und settings -FileEncoding UTF-8 myProject.und

Metric Settings

SettingOptionsExample
WriteColumnTitlesOn/Offund settings -MetricWriteColumnTitles On myProject.und
AddUniqueNameColumnOn/Offund settings -MetricAddUniqueNameColumn On myProject.und
ShowFunctionParameterTypesOn/Offund settings -MetricShowFunctionParameterTypes On myProject.und
ShowDeclaredInFileOn/Offund settings -MetricShowDeclaredInFile On myProject.und
DeclaredInFileDisplayModeNoPath/FullPath/RelativePathund settings -MetricDeclaredInFileDisplayMode NoPath myProject.und
FileNameDisplayModeNoPath/FullPath/RelativePathund settings -MetricFileNameDisplayMode NoPath myProject.und
ShowLineCountMetricsOn/Offund settings -MetricShowLineCountMetrics On myProject.und
InactiveLinesExclude/Include/Bothund settings -MetricInactiveLines Exclude myProject.und
ShowStatementCountMetricsOn/Offund settings -MetricShowStatementCountMetrics On myProject.und
BreakdownCountsByWebLanguageOn/Offund settings -MetricBreakdownCountsByWebLanguage On myProject.und
CyclomaticAll/Normal/Strict/Modified/StrictModifiedund settings -MetricCyclomatic All myProject.und
ShowMaximumNestingOn/Offund settings -MetricShowMaximumNesting On myProject.und
ShowPathsOn/Offund settings -MetricShowPaths On myProject.und
ShowKnotsOn/Offund settings -MetricShowKnots On myProject.und
ShowEssentialOn/Offund settings -MetricShowEssential On myProject.und
ShowInheritanceMetricsOn/Offund settings -MetricShowInheritanceMetrics On myProject.und
ShowMethodAndVariableCountMetricsOn/Offund settings -MetricShowMethodAndVariableCountMetrics On myProject.und
ShowDefaultSummaryMetricsOn/Offund settings -MetricShowDefaultSummaryMetrics On myProject.und
ShowAggregatedFileMetricsOn/Offund settings -MetricShowAggregatedFileMetrics On myProject.und
ShowAggregatedFunctionMetricsOn/Offund settings -MetricShowAggregatedFunctionMetrics On myProject.und
ShowAggregatedClassMetricsOn/Offund settings -MetricShowAggregatedClassMetrics On myProject.und

Report Settings

SettingOptionsExample
DisplayCreationDateOn/Offund settings -ReportDisplayCreationDate On myProject.und
DisplayParametersOn/Offund settings -ReportDisplayParameters On myProject.und
IndexByMethodOn/Offund settings -ReportIndexByMethod On myProject.und
GroupByDirectoryOn/Offund settings -ReportGroupByDirectory On myProject.und
DisplayHeaderTextOn/Offund settings -ReportDisplayHeaderText On myProject.und
DisplayUserHeaderTextOn/Offund settings -ReportDisplayUserHeaderText On myProject.und
FileNameDisplayModeFull/Shortund settings -ReportFileNameDisplayMode Full myProject.und
GenerateHTMLReportOn/Offund settings -ReportGenerateHTMLReport On myProject.und
NumberofPagesSingle/Alphabetic/NEntityund settings -ReportNumberofPages Single myProject.und
HTMLClearDirectoryOn/Offund settings -ReportHTMLClearDirectory On myProject.und
GenerateTextReportOn/Offund settings -ReportGenerateTextReport On myProject.und
NumberOfFilesSingle/Separateund settings -ReportNumberOfFiles Single myProject.und

Ada Settings

SettingOptionsExample
DisplayOriginal/Upper/Lower/First/Mixedund settings -AdaDisplay Original myProject.und
LinkageCaseLowercase/Uppercaseund settings -AdaLinkageCase Lowercase myProject.und
CountAndOrOperatorsOn/Offund settings -AdaCountAndOrOperators On myProject.und
CountExceptionsHandlersOn/Offund settings -AdaCountExceptionsHandlers On myProject.und
CountForLoopsOn/Offund settings -AdaCountForLoops On myProject.und
CreateRecordObjectComponentsOn/Offund settings -AdaCreateRecordObjectComponents On myProject.und
CreateRelationsBetweenFormalAndActualParametersOn/Offund settings -AdaCreateRelationsBetweenFormalAndActualParameters On myProject.und
OptimizeForLessMemoryOn/Offund settings -AdaOptimizeForLessMemory On myProject.und
SaveCommentsWithEntitiesOn/Offund settings -AdaSaveCommentsWithEntities On myProject.und
PromptOnParseErrorOn/Offund settings -AdaPromptOnParseError On myProject.und
VersionAda83/Ada95/Ada05/Ada12und settings -AdaVersion Ada83 myProject.und
PreprocessorNone/C/Gnatprep/GreenHills/Verdixund settings -AdaPreprocessor None myProject.und

Basic Settings

SettingOptionsExample
Analyze Reference DLLsOn/Offund settings -BasicAnalyzeReferenceDLLs On myProject.und

C/C++ Settings

SettingOptionsExample
UseStrictOn/Offund settings -C++UseStrict On myProject.und
CreateUniqueEntitiesForObjectDataMembersOn/Offund settings -C++CreateUniqueEntitiesForObjectDataMembers On myProject.und
CreateUniqueEntitiesForObjectFunctionMembersOn/Offund settings -C++CreateUniqueEntitiesForObjectFunctionMembers On myProject.und
CreateReferencesInInactiveCodeOn/Offund settings -C++CreateReferencesInInactiveCode On myProject.und
SaveCommentsWithEntitiesOn/Offund settings -C++SaveCommentsWithEntities On myProject.und
SaveMacroExpansionTextOn/Offund settings -C++SaveMacroExpansionText On myProject.und
SimplifyMacroExpansionOn/Offund settings -C++SimplifyMacroExpansion On myProject.und
StartWorkerProcessesSeriallyOn/Offund settings -C++StartWorkerProcessesSerially On myProject.und
AddFoundFilesToProjectOn/Offund settings -C++AddFoundFilesToProject On myProject.und
AddFoundSystemFilesOn/Offund settings -C++AddFoundSystemFiles On myProject.und
SearchForIncludesInProjectOn/Offund settings -C++SearchForIncludesInProject On myProject.und
IgnoreDirectoryOn/Offund settings -C++IgnoreDirectory On myProject.und
AnalyzeHeadersInIsolationOn/Offund settings -C++AnalyzeHeadersInIsolation On myProject.und
DisableSystemIncludesOn/Offund settings -C++DisableSystemIncludes On myProject.und
DisableCxxStdLibIncludesOn/Offund settings -C++DisableCxxStdLibIncludes On myProject.und
AllowNestedCommentsOn/Offund settings -C++AllowNestedComments On myProject.und
IgnorePreprocessorConditionalsOn/Offund settings -C++IgnorePreprocessorConditionals On myProject.und
TreatSystemIncludesAsUserOn/Offund settings -C++TreatSystemIncludesAsUser On myProject.und
CreateImplicitSpecialMemberFunctionsOn/Offund settings -C++CreateImplicitSpecialMemberFunctions On myProject.und
CreateReferencesInAssemblyOn/Offund settings -C++CreateReferencesInAssembly On myProject.und
CreateReferencesToLocalObjectsOn/Offund settings -C++CreateReferencesToLocalObjects On myProject.und
CreateReferencesToMacrosDuringMacroExpansionOn/Offund settings -C++CreateReferencesToMacrosDuringMacroExpansion On myProject.und
CreateReferencesToParameterOn/Offund settings -C++CreateReferencesToParameter On myProject.und
SaveDuplicateReferencesOn/Offund settings -C++SaveDuplicateReferences On myProject.und
UseIncludeCacheOn/Offund settings -C++UseIncludeCache On myProject.und

C# Settings

SettingOptionsExample
AnalyzeReferenceDLLsOn/Offund settings -C#AnalyzeReferenceDLLs On myProject.und
SaveCommentsWithEntitiesOn/Offund settings -C#SaveCommentsWithEntities On myProject.und

Fortran Settings

SettingOptionsExample
DisplayOriginal/Upper/Lower/First/Mixedund settings -FortranDisplay Original myProject.und
AllowCStyleCommentsOn/Offund settings -FortranAllowCStyleComments On myProject.und
AllowSemicolonStarCommentsOn/Offund settings -FortranAllowSemicolonStarComments On myProject.und
AllowColonsInNamesOn/Offund settings -FortranAllowColonsInNames On myProject.und
AllowFunctionDeclarationWithoutParenthesesOn/Offund settings -FortranAllowFunctionDeclarationWithoutParentheses On myProject.und
AllowParameterDeclarationWithoutParenthesesOn/Offund settings -FortranAllowParameterDeclarationWithoutParentheses On myProject.und
AllowQuoteInOctalConstantsOn/Offund settings -FortranAllowQuoteInOctalConstants On myProject.und
CaseSensitiveIdentifiersOn/Offund settings -FortranCaseSensitiveIdentifiers On myProject.und
UsePreprocessorOn/Offund settings -FortranUsePreprocessor On myProject.und
FormatAuto/Free/Fixedund settings -FortranFormat Auto myProject.und
CaseLowercase/Uppercase/Preserveund settings -FortranCase Lowercase myProject.und
PromptOnParseErrorOn/Offund settings -FortranPromptOnParseError On myProject.und
SaveComments with EntitiesOn/Offund settings -FortranSaveCommentswithEntities On myProject.und
TruncateAuto/None/72/132/Customund settings -FortranTruncate Auto myProject.und
VersionFortran77/Fortran90/Fortran95/Fortran03/Fortran08/Fortran18und settings -FortranVersion Fortran77 myProject.und

Java Settings

SettingOptionsExample
IncludePackageNameOn/Offund settings -JavaIncludePackageName On myProject.und
SaveComments with EntitiesOn/Offund settings -JavaSaveCommentswithEntities On myProject.und
Version1.3/1.4/5/6/7/8/9/10-21und settings -JavaVersion 1.3 myProject.und

Jovial Settings

SettingOptionsExample
ExpandCopyFileReferencesOn/Offund settings -JovialExpandCopyFileReferences On myProject.und
DisplayOriginal/Upper/Lower/First/Mixedund settings -JovialDisplay Original myProject.und
CaseLowercase/Uppercase/Preserveund settings -JovialCase Lowercase myProject.und
TruncateCustom/None/72und settings -JovialTruncate None myProject.und
VersionJovial3/Jovial73und settings -JovialVersion Jovial3 myProject.und

Pascal Settings

SettingOptionsExample
AllowEmbeddedSQLOn/Offund settings -PascalAllowEmbeddedSQL On myProject.und
DisplayOriginal/Upper/Lower/First/Mixedund settings -PascalDisplay Original myProject.und
CaseLowercase/Preserve/Uppercaseund settings -PascalCase Lowercase myProject.und
VersionDelphi/Compaq/DEC/HP/Pascal86/Turbo/VSIund settings -PascalVersion Delphi myProject.und

Python Settings

SettingOptionsExample
UseBuiltinStandardOn/Offund settings -PythonUseBuiltinStandard On myProject.und
UseInstalledStandardOn/Offund settings -PythonUseInstalledStandard On myProject.und
PythonSetVersionPython2/Python3und settings -PythonSetVersion Python2 myProject.und
SaveComments with EntitiesOn/Offund settings -PythonSaveCommentswithEntities On myProject.und
AssumeNearestMatchesOn/Offund settings -PythonAssumeNearestMatches On myProject.und
IgnoreImportErrorsInTryBlocksOn/Offund settings -PythonIgnoreImportErrorsInTryBlocks On myProject.und

Rust Settings

SettingOptionsExample
Release ProfileOn/Offund settings -RustReleaseProfile On myProject.und

Web Settings

SettingOptionsExample
AddFoundImportedJSFilesOn/Offund settings -WebAddFoundImportedJSFiles On myProject.und
AllowAspStylePhpTagsOn/Offund settings -WebAllowAspStylePhpTags On myProject.und
AllowShortPhpTagsOn/Offund settings -WebAllowShortPhpTags On myProject.und
PhpVersion5.3/5.4/5.5/5.6/7.0/7.1/7.2/7.3/7.4/8.0/8.1/8.2/8.3und settings -PhpVersion 5.3 myProject.und
AllowJQueryOn/Offund settings -WebAllowJQuery On myProject.und
AllowNodeJSOn/Offund settings -WebAllowNodeJS On myProject.und
SearchStringsForEntityNamesOn/Offund settings -WebSearchStringsForEntityNames On myProject.und