3.2.6.3.4 cmdname

The command name (<cmdname>) element specifies the name of a command when it is part of a software discussion. This element is part of the DITA software domain, a special set of DITA elements designed to document software tasks, concepts and reference information.

Contains

Doctype

Content model

topic (technical content), map (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task, bookmap

( text data or text) (any number)

Contained by

Doctype

Content model

topic (technical content), concept

data, title, navtitle, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, indexterm, index-base, cite, xref, entry, author, source, publisher, copyrholder, category, keywords, prodname, brand, series, platform, prognum, featnum, component, searchtitle, abstract, bodydiv, section, sectiondiv, example, linktext, linkinfo, b, u, i, tt, sup, sub, coords, index-see, index-see-also, index-sort-as, typeofhazard, consequence, howtoavoid, uicontrol, screen, codeph, codeblock, var, oper, delim, sep, pt, pd, fragref, synnote, repsep, msgph, msgblock, filepath, userinput, systemoutput

map (technical content)

data, title, navtitle, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, indexterm, index-base, cite, xref, entry, author, source, publisher, copyrholder, category, keywords, prodname, brand, series, platform, prognum, featnum, component, linktext, searchtitle, index-see, index-see-also, index-sort-as, b, u, i, tt, sup, sub, coords, typeofhazard, consequence, howtoavoid, uicontrol, screen, codeph, codeblock, var, oper, delim, sep, pt, pd, fragref, synnote, repsep, msgph, msgblock, filepath, userinput, systemoutput

ditabase

data, title, navtitle, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, indexterm, index-base, cite, xref, entry, author, source, publisher, copyrholder, category, keywords, prodname, brand, series, platform, prognum, featnum, component, searchtitle, abstract, bodydiv, section, sectiondiv, example, linktext, linkinfo, prereq, context, steps-informal, stepsection, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, refsyn, proptypehd, propvaluehd, propdeschd, proptype, propvalue, propdesc, glossterm, glossdef, glossAbbreviation, glossAcronym, glossShortForm, glossSynonym, glossProperty, glossSurfaceForm, glossUsage, glossScopeNote, b, u, i, tt, sup, sub, coords, index-see, index-see-also, index-sort-as, typeofhazard, consequence, howtoavoid, uicontrol, screen, codeph, codeblock, var, oper, delim, sep, pt, pd, fragref, synnote, repsep, msgph, msgblock, filepath, userinput, systemoutput

glossary, glossentry, glossgroup

data, title, navtitle, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, indexterm, index-base, cite, xref, entry, author, source, publisher, copyrholder, category, keywords, prodname, brand, series, platform, prognum, featnum, component, searchtitle, abstract, bodydiv, section, sectiondiv, example, linktext, linkinfo, glossterm, glossdef, glossAbbreviation, glossAcronym, glossShortForm, glossSynonym, glossProperty, glossSurfaceForm, glossUsage, glossScopeNote, b, u, i, tt, sup, sub, coords, index-see, index-see-also, index-sort-as, typeofhazard, consequence, howtoavoid, uicontrol, screen, codeph, codeblock, var, oper, delim, sep, pt, pd, fragref, synnote, repsep, msgph, msgblock, filepath, userinput, systemoutput

reference

data, title, navtitle, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, indexterm, index-base, cite, xref, entry, author, source, publisher, copyrholder, category, keywords, prodname, brand, series, platform, prognum, featnum, component, searchtitle, abstract, bodydiv, section, sectiondiv, example, linktext, linkinfo, refsyn, proptypehd, propvaluehd, propdeschd, proptype, propvalue, propdesc, b, u, i, tt, sup, sub, coords, index-see, index-see-also, index-sort-as, typeofhazard, consequence, howtoavoid, uicontrol, screen, codeph, codeblock, var, oper, delim, sep, pt, pd, fragref, synnote, repsep, msgph, msgblock, filepath, userinput, systemoutput

task (strict), task (general)

data, title, navtitle, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, indexterm, index-base, cite, xref, entry, author, source, publisher, copyrholder, category, keywords, prodname, brand, series, platform, prognum, featnum, component, searchtitle, abstract, bodydiv, section, sectiondiv, example, linktext, linkinfo, prereq, context, steps-informal, stepsection, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, b, u, i, tt, sup, sub, coords, index-see, index-see-also, index-sort-as, typeofhazard, consequence, howtoavoid, uicontrol, screen, codeph, codeblock, var, oper, delim, sep, pt, pd, fragref, synnote, repsep, msgph, msgblock, filepath, userinput, systemoutput

bookmap

data, title, navtitle, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, indexterm, index-base, cite, xref, entry, author, source, publisher, copyrholder, category, keywords, prodname, brand, series, platform, prognum, featnum, component, linktext, searchtitle, person, organization, summary, printlocation, revisionid, year, month, day, bookpartno, edition, isbn, booknumber, volume, booklibrary, mainbooktitle, booktitlealt, index-see, index-see-also, index-sort-as, organizationname, honorific, firstname, middlename, lastname, generationidentifier, otherinfo, addressdetails, locality, localityname, administrativearea, thoroughfare, postalcode, country, contactnumber, emailaddress, url, b, u, i, tt, sup, sub, coords, typeofhazard, consequence, howtoavoid, uicontrol, screen, codeph, codeblock, var, oper, delim, sep, pt, pd, fragref, synnote, repsep, msgph, msgblock, filepath, userinput, systemoutput

Inheritance

+ topic/keyword sw-d/cmdname

Example
<p>Use the <cmdname>rm</cmdname> command when
you wish to remove something forever.</p>
Attributes

Name

Description

Data Type

Default Value

Required?

univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups)

A set of related attributes, described in 3.4.1.3 univ-atts attribute group

     

global-atts attribute group (xtrf, xtrc)

A set of related attributes, described in 3.4.1.2 global-atts attribute group

     

class, outputclass, keyref

Class and outputclass are described in 3.4.1.9 Other common DITA attributes

     

Previous Topic:  3.2.6.3.3 msgnum

Next Topic:  3.2.6.3.5 varname

Parent Topic:  3.2.6.3 Software elements

Sibling Topics:

3.2.6.3.1 msgph

3.2.6.3.2 msgblock

3.2.6.3.3 msgnum

3.2.6.3.5 varname

3.2.6.3.6 filepath

3.2.6.3.7 userinput

3.2.6.3.8 systemoutput