Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/GP-817_jpleasu_analyzeHealdess_d…
Browse files Browse the repository at this point in the history
…ocs_for_scriptlog_and_python' into patch
  • Loading branch information
ghidra1 committed Apr 21, 2021
2 parents baeef06 + 9005a47 commit fbc8a6f
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions Ghidra/RuntimeScripts/Common/support/analyzeHeadlessREADME.html
Original file line number Diff line number Diff line change
Expand Up @@ -361,8 +361,13 @@ <h2><a name="usage">Headless Analyzer Usage</a></h2>
path to a script log file is not set, script logs are written to <typewriter>script.log</typewriter>
in the user directory, by default.
<br><br>
NOTE: Only the built-in scripting print methods will print to the the script log file
(print, println, printf, printerr).
Note: Only the built-in scripting print methods will print to the the
script log file (<typewriter>print</typewriter>,
<typewriter>println</typewriter>, <typewriter>printf</typewriter>,
<typewriter>printerr</typewriter>).
<br><br>Also note that in Python scripts, <typewriter>print</typewriter>
writes to <typewriter>stdout</typewriter>. To write to the log from
Python, use <typewriter>println</typewriter> instead.
</LI>

<br><br>
Expand Down Expand Up @@ -519,7 +524,7 @@ <h2><a name="usage">Headless Analyzer Usage</a></h2>
Although this method of authentication is normally discouraged, the server connection will
likely fail authentication if a password is required and this parameter is not enabled.
<br>
<b><u><i>NOTE: In some cases, password entry will be echoed to the console (a warning will show at
<b><u><i>Note: In some cases, password entry will be echoed to the console (a warning will show at
password prompt).</i></u></b>
</LI>

Expand Down Expand Up @@ -881,7 +886,7 @@ <h3><a name="scripting_passParams">Passing Parameters using <typewriter>askXxx()

</PRE>
</P>
<b>NOTE: </b>If <a href="#scripting_passArgs">script-specific arguments</a> have been passed into the
<b>Note: </b>If <a href="#scripting_passArgs">script-specific arguments</a> have been passed into the
script, the <typewriter>askXxx()</typewriter> methods will consume values found in the argument array
rather than a <typewriter>.properties</typewriter> file. The first <typewriter>askXxx()</typewriter>
method will use the first value in the array, the second <typewriter>askXxx()</typewriter> method will
Expand Down Expand Up @@ -946,7 +951,7 @@ <h3><a name="scripting_headlessScripts_enableDisableAnalysis">Headless Scripts:
</P>

<P>
NOTE: To check whether analysis is currently enabled, use the following method:
Note: To check whether analysis is currently enabled, use the following method:

<PRE>
boolean analysisEnabled = isHeadlessAnalysisEnabled();
Expand Down

0 comments on commit fbc8a6f

Please sign in to comment.