docs/173704: [PATCH] Addition to port searching feature - quicksearch

[Edward]

>Number:         173704
>Category:       docs
>Synopsis:       [PATCH] Addition to port searching feature - quicksearch
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Sun Nov 18 16:50:01 UTC 2012
>Closed-Date:
>Last-Modified:
>Originator:     Edward
>Release:        FreeBSD 8.3-RELEASE amd64
>Organization:
>Environment:
System: FreeBSD docs 8.3-RELEASE FreeBSD 8.3-RELEASE #0: Mon Apr 9 21:23:18 UTC 2012 root at mason.cse.buffalo.edu:/usr/obj/usr/src/sys/GENERIC amd64
>Description:
Searching for a port in /usr/ports has another feature other then "make search name=port-name", is "make quicksearch name=port-name". This patch attempt to add a brief intro and example of using this feature.

>How-To-Repeat:

>Fix:

--- diff.txt begins here ---
--- chapter.xml.original	2012-11-18 01:38:13.000000000 +0800
+++ chapter.xml	2012-11-19 00:15:49.000000000 +0800
@@ -349,19 +349,32 @@
 	  provided is not needed in order to install the port, so it
 	  will not be covered here.</para>
 
+	<para>Alternatively, there is another search feature from ports that
+	  achieves the same purpose but with less noise, the  
+	  <command>quicksearch</command> feature. This feature accepts the same 
+	  parameter as the <command>search</command> feature. For example, 
+	  searching for <command>lsof</command> would return:</para>
+
+	  <screen>&prompt.root; <userinput>cd /usr/ports</userinput>
+&prompt.root; <userinput>make quicksearch name=lsof</userinput>
+Port:   lsof-4.87.a,7
+Path:   /usr/ports/sysutils/lsof
+Info:   Lists information about open files (similar to fstat(1))</screen>
+
 	<para>For more in-depth searching you can also use
 	  <command>make <maketarget>search</maketarget>
-	    key=<replaceable>string</replaceable></command> where
-	  <replaceable>string</replaceable> is some text to search
-	  for.  This searches port names, comments, descriptions and
-	  dependencies and can be used to find ports which relate to a
-	  particular subject if you do not know the name of the
-	  program you are looking for.</para>
-
-	<para>In both of these cases, the search string is
-	  case-insensitive.  Searching for <quote>LSOF</quote> will
-	  yield the same results as searching for
-	  <quote>lsof</quote>.</para>
+	  key=<replaceable>string</replaceable></command> or <command>make 
+	  <maketarget>quicksearch</maketarget> 
+	  key=<replaceable>string</replaceable></command>, where
+	  <replaceable>string</replaceable> is some text to search for. This 
+	  searches port names, comments, descriptions and dependencies and can be 
+	  used to find ports which relate to a particular subject if you do not 
+	  know the name of the program you are looking for.</para>
+
+	<para>In both of these cases (<maketarget>search</maketarget> and 
+	  <maketarget>quicksearch</maketarget>), the search string is 
+	  case-insensitive.  Searching for <quote>LSOF</quote> will yield the same 
+	  results as searching for <quote>lsof</quote>.</para>
       </listitem>
     </itemizedlist>
   </sect1>
--- diff.txt ends here ---


>Release-Note:
>Audit-Trail:
>Unformatted: