📄 help.hlp
字号:
{smcl}
{* 28feb2005}{...}
{cmd:help help}{right:dialog: {bf:{help_d:help}}}
{hline}
{title:Title}
{p2colset 5 17 19 2}{...}
{p2col :{hi:[R] help} {hline 2}}Display online help{p_end}
{p2colreset}{...}
{title:Stata's help system}
{pstd}
Stata's help system consists of two commands:
1) {cmd:help}
2) {cmd:search}
{pstd}
You use {cmd:help} when you know the name of the Stata command on which you
want information.
{pstd}
You use {cmd:search} when you need to find out the name of the command. To
learn about {cmd:search} type "{bf:{help search:help search}}" at the Stata dot
prompt.
{c TLC}{hline 69}{c TRC}
{c |} {cmd:search} is how you find the command{space 34}{c |}
{c |} you are looking for; type{space 15}. {cmd:search} {it:any_word_or_phrase} {c |}
{c |}{space 69}{c |}
{c |} {cmd:help} is how you obtain help on a{space 36}{c |}
{c |} Stata command; type{space 21}. {cmd:help} {it:any_stata_command} {c |}
{c BLC}{hline 69}{c BRC}
{pstd}
Windows, Macintosh, and Unix(GUI) users can also use the interactive help
windowing system. For help on using the help system select {hi:Help} from the
main menu bar and then choose {hi:Contents}. A Viewer window will appear.
Press the {hi:Help!} button at the top of the window and help for the
interactive help system will then be presented.
{hline}
{title:Syntax}
{phang}Display help information in Viewer
{p 8 14 2}
{cmdab:h:elp} [{it:command_or_topic_name}] [{cmd:,} {it:options}]
{phang}Display help information in Results window
{p 8 14 2}
{cmd:chelp} [{it:command_or_topic_name}]
{synoptset 24}{...}
{synopthdr}
{synoptline}
{synopt:{opt non:ew}}display help file in the currently active Viewer window{p_end}
{synopt:{opt name(viewername)}}display help file in a Viewer window named {it:viewername}{p_end}
{synopt:{opt mark:er(markername)}}open help file at the {it:markername} position{p_end}
{synoptline}
{title:Description}
{pstd}
The {cmd:help} command displays help information about the specified command
or topic.
{phang}Stata for Windows, Stata for Macintosh, and Stata for Unix(GUI):{break}
{cmd:help} launches a new Viewer to display help for the specified command or
topic. If {cmd:help} is not followed by a command or a topic name, Stata
launches the Viewer and displays {cmd:help contents}, the table of contents
for the online help.
{pmore}Help may be accessed by either selecting {hi:Help > Stata command} and
filling in the command name for which help is desired or by typing {cmd:help}
followed by a command or topic name.
{pmore}{cmd:chelp} will display help in the Results window.
{phang}Stata for Unix(console):{break}
Typing {cmd:help} followed by a command name or a topic name will display
help on the console.
{pmore}If {cmd:help} is not followed by a command or a topic name, a
description of how to use the {cmd:help} system is displayed.
{phang}Stata for Unix(both GUI and console):{break}
{cmd:man} is a synonym for {cmd:chelp}.
{title:Options}
{phang}
{opt nonew} specifies that a new Viewer window not be opened for the help
topic if a Viewer window is already open. The default is for a new Viewer
window to be opened each time {cmd:help} is typed so that multiple help files
may be viewed at once. {cmd:nonew} causes the help file to be displayed in
the topmost open Viewer.
{phang}
{opt name(viewername)} specifies that help be displayed in a Viewer window
named {it:viewername}. If the named window already exists, its contents
will be replaced. If the named window does not exist, it will be created.
{phang}
{opt marker(markername)} specifies that the help file be opened to the
position of {it:markername} within the help file.
{title:Examples}
{cmd:. help}
{cmd:. help contents}
{cmd:. help list}
{cmd:. help list, name(list_help)}
{cmd:. help logistic postestimation, markername(lroc)}
{hline}
{title:What to do when you see {hline 2}more{hline 2}}
{pstd}
Stata pauses and displays the characters {cmd:{hline 2}more{hline 2}} at the
bottom of the results window whenever the output from a command is about to
scroll off the screen.
{col 13}Action{col 49}Result
{col 5}{hline 23}{col 32}{hline 40}
{col 5}Press {hi:Enter} or {hi:Return}{col 32}One more line of text is displayed
{col 5}Press {hi:b}{col 32}The previous screen of text is displayed
{col 5}Press {hi:Ctrl-K}{col 32}{hline 2}more{hline 2} condition is cleared and output stops
{col 5}Press {hi:q}{col 32}{hline 2}more{hline 2} condition is cleared and output stops
{col 5}Press any other key{col 32}The next screen of text is displayed
{col 9}(such as space bar)
{col 5}PCs:
{col 9}Press {hi:Ctrl-Break}{col 32}Stata stops processing the command ASAP
{col 5}Macintosh:
{col 9}Press {hi:Command-.}{col 34}" " " " " "
{col 5}Unix (Console):
{col 9}Press {hi:Ctrl-C}{col 34}" " " " " "
{col 5}Unix (GUI):
{col 9}Press {hi:Ctrl-Break}{col 34}" " " " " "
{pstd}
{hline 2}more{hline 2} happens all the time, not just in {cmd:chelp}, since
Stata does not scroll information off the screen without your permission.
{pstd}
These same keystrokes will work in response to a {hline 2}more{hline 2}
given by other commands, except that pressing {hi:b} only works with
{cmd:chelp}. You cannot press {hi:b} to back up to the previous screen with
other commands.
{title:Interrupting Stata commands}
{pstd}
You can press {hi:Ctrl-Break} (or {hi:Command-.} or {hi:Ctrl-C}) at any
time to interrupt any command in Stata, not just in response to
{hline 2}more{hline 2}.
{hline}
{title:Also see}
{psee}
Manual: {hi:[R] help}
{psee}
Online: {help contents},
{help net search},
{help search}
{p_end}
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -