i2p/haiku-beta6
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added some updates to hey documentation, for 1.2.6 --> 1.2.8 changes.

Browse Source 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39737 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
Matt Madia
2010-12-05 13:05:17 +00:00
parent 0e216008df
commit 2c9a0aae32
1 changed files with 40 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/bin/hey.html
+33 -10
View File
@@ -4,7 +4,7 @@
<TITLE>hey Documentation</TITLE> <TITLE>hey Documentation</TITLE>
</HEAD> </HEAD>
<BODY BGCOLOR=#FFFFFF> <BODY BGCOLOR=#FFFFFF>
<HR><CENTER><h1>hey version 1.2.6</h1> <HR><CENTER><h1>hey version 1.2.8</h1>
</CENTER> </CENTER>
<HR> <HR>
<BASEFONT size=4> <BASEFONT size=4>
@@ -28,17 +28,17 @@ Use it at your own risk.
<h2>Usage</h2> <h2>Usage</h2>
hey should be used from Terminal. When you start it without parameters it will display the command line syntax it accepts: hey should be used from Terminal. When you start it without parameters it will display the command line syntax it accepts:
<PRE><CODE> <PRE><CODE>
hey v1.2.6, written by Attila Mezei ([email protected]) hey v1.2.8, written by Attila Mezei (attila.[email protected])
usage: hey [-s] &lt;app|signature&gt; [let &lt;specifier&gt; do] &lt;verb&gt; &lt;specifier_1&gt; &lt;of &lt;specifier_n&gt;&gt;* usage: hey [-s][-o] &lt;app|signature|teamid&gt; [let &lt;specifier&gt; do] &lt;verb&gt; &lt;specifier_1&gt; &lt;of
[to &lt;value&gt;] [with name=&ltvalue&gt [and name=&ltvalue&gt]*] &lt;specifier_n&gt;&gt;* [to &lt;value&gt;] [with name=&lt;value&gt; [and name=&lt;value&gt;]*]
where &lt;verb&gt; : DO|GET|SET|COUNT|CREATE|DELETE|GETSUITES|QUIT|SAVE|LOAD|'what' where &lt;verb&gt; : DO|GET|SET|COUNT|CREATE|DELETE|GETSUITES|QUIT|SAVE|LOAD|'what'
&lt;specifier&gt; : [the] &lt;property_name&gt; [ &lt;index&gt; | name | "name" | '"name"'] &lt;specifier&gt; : [the] &lt;property_name&gt; [ &lt;index&gt; | name | "name" | '"name"' ]
&lt;index&gt; : index | '['index']' | '['-reverse_index']' | '['fromvalue to tovalue']'
&lt;index&gt; : int | -int | '['int']' | '['-int']' | '['startint to end']' &lt;index&gt; : int | -int | '['int']' | '['-int']' | '['startint to end']'
&lt;value&gt; : "string" | &lt;integer&gt; | &lt;float&gt; | bool(value) | int8(value) | &lt;value&gt; : "string" | &lt;integer&gt; | &lt;float&gt; | bool(value) | int8(value)
int16(value) | int32(value) | float(value) | double(value) | | int16(value) | int32(value) | float(value) | double(value)
BPoint(x,y) | BRect(l,t,r,b) | rgb_color(r,g,b,a) | file(path) | BPoint(x,y) | BRect(l,t,r,b) | rgb_color(r,g,b,a) | file(path)
options: -s: silent options: -s: silent
-o: output result to stdout for easy parsing
</CODE></PRE> </CODE></PRE>
<br> <br>
@@ -57,7 +57,7 @@ The verbs send the following messages:
<li>SAVE: B_SAVE_REQUESTED <li>SAVE: B_SAVE_REQUESTED
<li>LOAD: B_REFS_RECEIVED <li>LOAD: B_REFS_RECEIVED
</ul> </ul>
You can use your own verbs if you specify the value names and constants in the 'value_info' structure. See <A HREF="file:///boot/beos/documentation/Be%20Book/The%20Application%20Kit/PropertyInfo.html">BPropertyInfo</A> and <A HREF="file:///boot/develop/headers/be/app/PropertyInfo.h">PropertyInfo.h</A> for details. You can use your own verbs if you specify the value names and constants in the 'value_info' structure. See <A HREF="http://www.haiku-os.org/legacy-docs/bebook/BPropertyInfo_Overview.html">BPropertyInfo</A> and <A HREF="file:///boot/develop/headers/be/app/PropertyInfo.h">PropertyInfo.h</A> for details.
<p> <p>
Note that the verb is not case sensitive but the specifier names (e.g. "Frame", "Label"...) are. You can use 'what' constants Note that the verb is not case sensitive but the specifier names (e.g. "Frame", "Label"...) are. You can use 'what' constants
directly, like directly, like
@@ -102,6 +102,29 @@ You can check the message to be sent to the application by setting the DEBUG_HEY
<br> <br>
<h2>History</h2> <h2>History</h2>
v1.2.8
<ul>
<li>
(Sander Stoks): Added command-line option -o which will output the "result" value
in the reply message to stdout, so you can use it in shell scripting more easily:
"hey Becasso get AspectRatio of Canvas 0"
outputs
Reply BMessage(B_REPLY):
"result" (B_DOUBLE_TYPE) : 0.600
but "hey -o Becasso get AspectRatio of Canvas 0"
outputs 0.600000 directly.
</ul>
v1.2.7
<ul>
<li>
by Sander Stoks: Made a fork since I don't think Attila still supports "hey", and
because the latest version on BeBits seems to be 1.2.4.
Changes w.r.t. 1.2.6: When an application returns an error on a message, hey now
keeps iterating over applications with the same signature. This is useful because,
for instance, Terminal starts as a new process for each instance, so it previously
wouldn't work to move a specific Terminal window using hey. You can now say
"hey Terminal set Frame of Window foo to BRect[...]".
</ul>
v1.2.6 v1.2.6
<ul> <ul>
<li>syntax extended by Sander Stoks <sander@adamation.com> to allow: <li>syntax extended by Sander Stoks <sander@adamation.com> to allow: