Product SiteDocumentation Site

Preface

1. 文​档​约​定​

本​手​册​使​用​几​个​约​定​来​突​出​某​些​用​词​和​短​语​以​及​信​息​的​某​些​片​段​。​
在 PDF 版​本​以​及​纸​版​中​,本​手​册​使​用​在 Liberation 字​体​套​件​中​选​出​的​字​体​。​如​果​您​在​您​的​系​统​中​安​装​了 Liberation 字​体​套​件​,它​还​可​用​于 HTML 版​本​。​如​果​没​有​安​装​,则​会​显​示​可​替​换​的​类​似​字​体​。​请​注​意​:红​帽​企​业 Linux 5 以​及​其​后​的​版​本​默​认​包​含 Liberation 字​体​套​件​。​

1.1. 排​版​约​定​

我​们​使​用​四​种​排​版​约​定​突​出​特​定​用​词​和​短​语​。​这​些​约​定​及​其​使​用​环​境​如​下​。​
固​定​粗​体​
用​来​突​出​系​统​输​入​,其​中​包​括 shell 命​令​、​文​件​名​以​及​路​径​。​还​可​用​来​突​出​按​键​以​及​组​合​键​。​例​如​:
要​看​到​文​件​您​当​前​工​作​目​录​中​文​件 my_next_bestselling_novel 的​内​容​,请​在 shell 提​示​符​后​输​入 cat my_next_bestselling_novel 命​令​并​按 Enter 键​执​行​该​命​令​。​
以​上​内​容​包​括​一​个​文​件​名​,一​个 shell 命​令​以​及​一​个​按​键​,它​们​都​以​固​定​粗​体​形​式​出​现​,且​全​部​与​上​下​文​有​所​区​别​。​
组​合​键​可​通​过​使​用​连​字​符​连​接​组​合​键​的​每​个​部​分​来​与​按​键​区​别​。​例​如​:
Enter 执​行​该​命​令​。​
Ctrl+Alt+F1 切​换​到​第​一​个​虚​拟​终​端​。​Ctrl+Alt+F7 返​回​您​的 X-Windows 会​话​。​
第​一​句​突​出​的​是​要​按​的​特​定​按​键​。​第​二​句​突​出​了​两​个​三​按​键​组​合​,每​个​组​合​都​要​同​时​按​下​。​
如​果​讨​论​的​是​源​码​、​等​级​名​称​、​方​法​、​功​能​、​变​量​名​称​以​及​在​段​落​中​提​到​的​返​回​的​数​值​,那​么​都​会​以​上​述​形​式​出​现​,即​固​定​粗​体​。​例​如​:
与​文​件​相​关​的​等​级​包​括​用​于​文​件​系​统​的 filesystem、​用​于​文​件​的 file 以​及​用​于​目​录​的 dir。​每​个​等​级​都​有​其​自​身​相​关​的​权​限​。​
比​例​宽​度​粗​体​
这​是​指​在​系​统​中​遇​到​的​文​字​或​者​短​语​,其​中​包​括​应​用​程​序​名​称​、​对​话​框​文​本​、​标​记​的​按​钮​、​复​选​框​以​及​单​选​按​钮​标​签​、​菜​单​标​题​以​及​子​菜​单​标​题​。​例​如​:在​主​菜​单​栏​中​
选​择 系​统 > 属​性 > 鼠​标​启​动 Mouse Preferences。​在 按​钮​ 标​签​中​点​击​惯​用​左​手​鼠​标​ 复​选​框​并​点​击 关​闭​ 将​首​选​鼠​标​按​键​从​左​切​换​到​右​(让​鼠​标​适​合​左​手​使​用​)。​
要​在 gedit 文​件​中​插​入​一​个​特​殊​字​符​,请​在​主​菜​单​栏​中​选​择 应​用​程​序 > 附​件 > 字​符​映​射​表​。​下​面​请​在​字​符​映​射​表​ 主​菜​单​栏​中​选​择 搜​索 > 查​找​…,在​搜​索​ 字​段​输​入​字​符​名​称​,并​点​击 下​一​个​。​那​么​会​在 字​符​表​中​突​出​您​看​到​的​字​符​。​双​击​该​字​符​将​其​放​置​于 要​复​制​的​文​本​字​段​并​点​击 复​制​ 按​钮​。​现​在​返​回​您​的​文​档​,在 gedit 菜​单​栏​选​择 编​辑 > 粘​贴​。​
以​上​文​本​包​括​应​用​程​序​名​称​、​系​统​范​围​菜​单​名​称​及​项​目​、​特​定​应​用​程​序​菜​单​名​称​以​及​按​钮​和 GUI 界​面​中​的​文​本​,所​有​都​以​比​例​粗​体​出​现​并​与​上​下​文​区​别​。​
请​注​意​在​菜​单​及​其​子​菜​单​中​用​来​表​示​穿​越​的 >。​这​是​为​了​避​免​使​用​比​较​复​杂​的​方​法​,比​如​‘​在​主​菜​单​的 系​统​ 菜​单​中​的 首​选​项​ 菜​单​中​选​择​鼠​标​’​。​
固​定​粗​斜​体​ 或​者 比​例​粗​斜​体
无​论​固​定​粗​体​或​者​比​例​粗​体​,附​加​的​斜​体​表​明​是​可​替​换​或​者​变​量​文​本​。​斜​体​表​示​那​些​不​直​接​输​入​的​文​本​或​者​那​些​根​据​环​境​改​变​的​文​本​。​例​如​:
要​使​用 ssh 连​接​到​远​程​机​器​,请​在 shell 提​示​符​后​输​入 ssh username@domain.name。​如​果​远​程​机​器​是 example.com 且​您​在​该​其​机​器​中​的​用​户​名​为 john,请​输​入 ssh john@example.com。​
mount -o remount file-system 命​令​会​重​新​挂​载​命​名​的​文​件​系​统​。​例​如​:要​重​新​挂​载 /home 文​件​系​统​,则​命​令​为 mount -o remount /home。​
要​查​看​目​前​安​装​的​软​件​包​版​本​,请​使​用 rpm -q package 命​令​。​它​会​返​回​以​下​结​果​:package-version-release。​
请​注​意​以​上​文​字​中​的​粗​斜​体​字 — username、​domain.name、​file-system、​package、​version 和 release。​无​论​您​输​入​文​本​或​者​运​行​一​个​命​令​,还​是​该​系​统​显​示​的​文​本​,每​个​字​都​是​一​个​占​位​符​。​
不​考​虑​工​作​中​显​示​标​题​的​标​准​用​法​,斜​体​表​示​第​一​次​使​用​某​个​新​且​重​要​的​用​语​。​例​如​:
当 Apache HTTP 服​务​器​接​受​请​求​时​,它​会​分​派​子​进​程​或​者​线​程​对​其​进​行​处​理​。​这​组​子​进​程​或​者​线​程​就​是 服​务​器​池​(server-pool)。​在 Apache HTTP 服​务​器 2.0 中​,创​建​和​维​护​服​务​器​池​的​任​务​是​由​名​为 多​进​程​模​块​(Multi-Processing Modules)MPMs)的​模​块​负​责​的​。​和​其​它​模​块​不​同​,Apache HTTP 服​务​器​只​能​载​入 MPM 组​中​的​一​个​模​块​。​

1.2. 抬​升​式​引​用​约​定​

二​,一​般​是​多​行​,数​据​输​入​要​明​显​与​周​围​文​本​分​开​。​
将​发​送​到​终​端​的​输​入​设​置​为 Mono-spaced Roman 并​显​示​为​:
books        Desktop   documentation  drafts  mss    photos   stuff  svn
books_tests  Desktop1  downloads      images  notes  scripts  svgs
源​码​列​表​也​设​为 Mono-spaced Roman,但​以​下​面​的​形​式​出​现​和​突​出​:
package org.jboss.book.jca.ex1;

import javax.naming.InitialContext;

public class ExClient
{
   public static void main(String args[]) 
       throws Exception
   {
      InitialContext iniCtx = new InitialContext();
      Object         ref    = iniCtx.lookup("EchoBean");
      EchoHome       home   = (EchoHome) ref;
      Echo           echo   = home.create();

      System.out.println("Created Echo");

      System.out.println("Echo.echo('Hello') = " + echo.echo("Hello"));
   }
   
}

1.3. 备​注​及​警​告​

最​后​,我​们​使​用​三​种​视​觉​形​式​来​突​出​那​些​可​能​被​忽​视​的​信​息​。​

备​注​

备​注​是​对​手​头​任​务​的​提​示​、​捷​径​或​者​另​外​的​解​决​方​法​。​忽​略​提​示​不​会​造​成​负​面​后​果​,但​您​可​能​会​错​过​一​个​更​省​事​的​诀​窍​。​

重​要​

重​要​框​中​的​内​容​是​那​些​容​易​错​过​的​事​情​:配​置​更​改​只​可​用​于​当​前​会​话​,或​者​在​应​用​更​新​前​要​重​启​服​务​。​忽​略​重​要​框​中​的​内​容​不​会​造​成​数​据​丢​失​但​可​能​会​让​您​抓​狂​。​

警​告​

警​告​是​不​应​被​忽​略​的​。​忽​略​警​告​信​息​很​可​能​导​致​数​据​丢​失​。​