Received: from maia.hub.org (maia-2.hub.org [200.46.204.251])
	by mail.postgresql.org (Postfix) with ESMTP id 43DBF1337BED
	for <pgsql-docs-postgresql.org@mail.postgresql.org>;
	Fri,  1 Apr 2011 12:18:37 -0300 (ADT)
Received: from mail.postgresql.org ([200.46.204.86])
	by maia.hub.org (mx1.hub.org [200.46.204.251]) (amavisd-maia,
	port 10024) with ESMTP id 99932-02-9 for
	<pgsql-docs-postgresql.org@mail.postgresql.org>;
	Fri,  1 Apr 2011 15:18:19 +0000 (UTC)
X-Greylist: from auto-whitelisted by SQLgrey-1.7.6
Received: from spinlock.commandprompt.com (host-215.commandprompt.net
	[207.173.203.215])
	by mail.postgresql.org (Postfix) with ESMTP id CA9881337B3E
	for <pgsql-docs@postgresql.org>; Fri,  1 Apr 2011 12:17:26 -0300 (ADT)
Received: from localhost (localhost [127.0.0.1])
	by spinlock.commandprompt.com (Postfix) with ESMTP id 1F1C0348048
	for <pgsql-docs@postgresql.org>; Fri,  1 Apr 2011 08:17:23 -0700 (PDT)
X-Virus-Scanned: Debian amavisd-new at commandprompt.com
Received: from spinlock.commandprompt.com ([127.0.0.1])
	by localhost (spinlock.commandprompt.com.commandprompt.com [127.0.0.1])
	(amavisd-new, port 10024)
	with ESMTP id DQP4g2Fv1Nhp for <pgsql-docs@postgresql.org>;
	Fri,  1 Apr 2011 08:17:21 -0700 (PDT)
Received: from perhan.alvh.no-ip.org (unknown [200.126.118.36])
	by spinlock.commandprompt.com (Postfix) with ESMTPSA id 12892348022
	for <pgsql-docs@postgresql.org>; Fri,  1 Apr 2011 08:17:21 -0700 (PDT)
Received: by perhan.alvh.no-ip.org (Postfix, from userid 1000)
	id 28BDA6E400; Fri,  1 Apr 2011 12:17:18 -0300 (CLST)
Content-Type: text/plain; charset=UTF-8
Subject: psql's \h MOVE
From: Alvaro Herrera <alvherre@alvh.no-ip.org>
To: Pg Docs <pgsql-docs@postgresql.org>
Date: Fri, 01 Apr 2011 12:17:18 -0300
Message-Id: <1301670352-sup-4920@alvh.no-ip.org>
User-Agent: Sup/git
Content-Transfer-Encoding: 8bit
X-Virus-Scanned: Maia Mailguard 1.0.1
X-Spam-Status: No, hits=-1.9 tagged_above=-5 required=5 tests=BAYES_00=-1.9
X-Spam-Level: 
X-Archive-Number: 201104/2
X-Sequence-Number: 6573

I just noticed that \h MOVE is particularly unhelpful:

	alvherre=# \h move
	Command:     MOVE
	Description: position a cursor
	Syntax:
	MOVE [ direction { FROM | IN } ] cursorname


The problem is that it doesn't specify what "direction" is.  The doc
text tells you to look into FETCH for details, but in \h you have to
guess.

We could fix this by including a note about fetch in the <synopsis>,
so that it'd look like this:

	alvherre=# \h move
	Command:     MOVE
	Description: position a cursor
	Syntax:
	MOVE [ direction [ FROM | IN ] ] cursor_name

	See FETCH for details on direction

This, of course, also appears in the HTML output.

This requires this simple patch:

--- a/doc/src/sgml/ref/move.sgml
+++ b/doc/src/sgml/ref/move.sgml
@@ -27,6 +27,8 @@ PostgreSQL documentation
  <refsynopsisdiv>
 <synopsis>
 MOVE [ <replaceable class="PARAMETER">direction</replaceable> [ FROM | IN ] ] <replaceable class="PARAMETER">cursor_name</replaceable>
+
+<phrase>See <command>FETCH</command> for details on <replaceable class="PARAMETER">direction</replaceable>.</phrase>
 </synopsis>
  </refsynopsisdiv>


Would anybody object to doing things this way?

The alternative I see is to expand the "direction" in the MOVE synopsis,
but it is repetitive and would require more maintenance should we ever
decide to change the possible directions.

-- 
Álvaro Herrera <alvherre@alvh.no-ip.org>