Convenciones utilizadas en la documentación

Se utilizan varias convenciones en la documentación para términos, acciones, mandatos y vías de acceso especiales que dependen del sistema operativo y para información específica de la plataforma y del producto.

Convenciones de tipo de letra

En la documentación se utilizan las siguientes convenciones de tipo de letra:
Negrita
  • Comandos en minúsculas, mandatos en mayúsculas y minúsculas, parámetros y variables de entorno que son difíciles de distinguir del texto circundante
  • Controles de interfaz (recuadros de selección, botones, botones de selección, selectores cíclicos, campos, carpetas, iconos, recuadros de lista, elementos dentro de recuadros de lista, listas de varias columnas, contenedores, opciones de menú, nombres de menú, pestañas, hojas de propiedades), etiquetas (como Sugerencia:)
  • Palabras clave y parámetros del texto
Cursiva
  • Citas (ejemplos: títulos de publicaciones, disquetes y discos CD)
  • Palabras y frases definidas en el texto (ejemplo: una línea no conmutada se denomina una línea punto a punto)
  • Resaltado de palabras y letras (ejemplo: la dirección de LUN debe comenzar por la letra L).
  • Nuevos términos en el texto, excepto en una lista de definiciones (por ejemplo: una vista es un marco en un espacio de trabajo que contiene datos).
  • Variables y valores que se deben proporcionar (ejemplo: donde minombre representa…)
Monoespaciado
  • Ejemplos y códigos de ejemplo
  • Nombres de archivo, nombres de directorio, nombres de ruta, directivas de programación, propiedades y otros elementos que son difíciles de distinguir del texto circundante
  • Texto de mensajes y solicitudes
  • Texto que debe escribir el usuario
  • Valores para argumentos u opciones de mandatos
Negrita monoespaciado
  • Nombres de mandatos y nombres de macros y programas de utilidad que se pueden escribir como mandatos
  • Nombres de variables de entorno en el texto
  • Palabras clave
  • Nombres de parámetros en el texto: parámetros de estructura de API, parámetros y argumentos de mandato y parámetros de configuración
  • Nombres de procesos
  • Nombres de variables de registro en el texto
  • Nombres de scripts

Variables y vías de acceso dependientes del sistema operativo

La dirección de la barra inclinada de las rutas de directorio puede variar en la documentación. Independientemente de lo que pueda verse en la documentación, siga estas directrices:
  • Linux o AIX Utilice una barra diagonal (/).
  • Windows Utilice una barra inclinada invertida (\).

Los nombres de las variables de entorno no siempre son los mismos en Windows y AIX. Por ejemplo, %TEMP% en Windows es equivalente a $TMPDIR en AIX or Linux.

Para variables de entorno, siga estas directrices:
  • Linux o AIX Utilice $variable.
  • Windows Utilice %variable%.

WindowsSi está utilizando el shell Bash en un sistema Windows, puede utilizar las convenciones AIX.

Directorio de instalación variable y vías de acceso para los agentes

dir_instalación es el directorio de instalación para los agentes. La ubicación predeterminada depende del sistema operativo:
  • WindowsC:\IBM\APM
  • Linux/opt/ibm/apm/agent
  • AIX/opt/ibm/apm/agent