Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

sgmls::refs(3pm) [debian man page]

Refs(3pm)						User Contributed Perl Documentation						 Refs(3pm)

NAME

       SGMLS::Refs - Forward reference handling

SYNOPSIS

	 use SGMLS::Refs;

       To create a new reference-manager object using the file "foo.refs":

	 my $refs = new SGMLS::Refs("foo.refs");

       To create a new reference-manager object using the file "foo.refs" and logging changes to the file "foo.log":

	 my $refs = new SGMLS::Refs("foo.refs","foo.log");

       To record a reference:

	 $refs->put("document title",$title);

       To retrieve a reference:

	 $title = $refs->get("document title");

       To return the number of references changed since the last run:

	 $num = $refs->changed;

       To print a LaTeX-like warning if any references have changed:

	 $refs->warn;

DESCRIPTION

       This library can be used together with the SGMLS package to keep track of forward references from one run to another, like the LaTeX ".aux"
       files.  Each reference manager is an object which reads and then rewrites a file of perl source, with the file name provided by the caller.

       Example:

	 # Start up the reference manager before the parse.
	 sgml('start', sub { $refs = new SGMLS::Refs("foo.refs"); });

	 # Warn about any changed references at the end.
	 sgml('end', sub { $refs->warn; });

	 # Look up the title from the last parse, if available.
	 sgml('<div>', sub {
	   my $element = shift;
	   my $id = $element->attribute(ID)->value;
	   my $title = $refs->get("title:$id") || "[no title available]";

	   $current_div_id = $id;

	   output "\section{$title}

";
	 });

	 # Save the title for the next parse.
	 sgml('<head>', sub { push_output('string'); });
	 sgml('</head>', sub {
	   my $title = pop_output();
	   my $id = $current_div_id;

	   $refs->put("title:$id",$title);
	 });

AUTHOR AND COPYRIGHT

       Copyright 1994 and 1995 by David Megginson, "dmeggins@aix1.uottawa.ca".	Distributed under the terms of the Gnu General Public License
       (version 2, 1991) -- see the file "COPYING" which is included in the SGMLS.pm distribution.

SEE ALSO
:
       SGMLS, SGMLS::Output.

perl v5.8.8							    2004-02-22								 Refs(3pm)

Check Out this Related Man Page

GIT-LS-REMOTE(1)						    Git Manual							  GIT-LS-REMOTE(1)

NAME

       git-ls-remote - List references in a remote repository

SYNOPSIS

       git ls-remote [--heads] [--tags]  [-u <exec> | --upload-pack <exec>]
		     <repository> <refs>...

DESCRIPTION

       Displays references available in a remote repository along with the associated commit IDs.

OPTIONS

       -h, --heads, -t, --tags
	   Limit to only refs/heads and refs/tags, respectively. These options are not mutually exclusive; when given both, references stored in
	   refs/heads and refs/tags are displayed.

       -u <exec>, --upload-pack=<exec>
	   Specify the full path of git-upload-pack on the remote host. This allows listing references from repositories accessed via SSH and
	   where the SSH daemon does not use the PATH configured by the user.

       <repository>
	   Location of the repository. The shorthand defined in $GIT_DIR/branches/ can be used. Use "." (dot) to list references in the local
	   repository.

       <refs>...
	   When unspecified, all references, after filtering done with --heads and --tags, are shown. When <refs>... are specified, only
	   references matching the given patterns are displayed.

EXAMPLES

	   $ git ls-remote --tags ./.
	   d6602ec5194c87b0fc87103ca4d67251c76f233a	   refs/tags/v0.99
	   f25a265a342aed6041ab0cc484224d9ca54b6f41	   refs/tags/v0.99.1
	   7ceca275d047c90c0c7d5afb13ab97efdf51bd6e	   refs/tags/v0.99.3
	   c5db5456ae3b0873fc659c19fafdde22313cc441	   refs/tags/v0.99.2
	   0918385dbd9656cab0d1d81ba7453d49bbc16250	   refs/tags/junio-gpg-pub
	   $ git ls-remote http://www.kernel.org/pub/scm/git/git.git master pu rc
	   5fe978a5381f1fbad26a80e682ddd2a401966740	   refs/heads/master
	   c781a84b5204fb294c9ccc79f8b3baceeb32c061	   refs/heads/pu
	   b1d096f2926c4e37c9c0b6a7bf2119bedaa277cb	   refs/heads/rc
	   $ echo http://www.kernel.org/pub/scm/git/git.git >.git/branches/public
	   $ git ls-remote --tags public v*
	   d6602ec5194c87b0fc87103ca4d67251c76f233a	   refs/tags/v0.99
	   f25a265a342aed6041ab0cc484224d9ca54b6f41	   refs/tags/v0.99.1
	   c5db5456ae3b0873fc659c19fafdde22313cc441	   refs/tags/v0.99.2
	   7ceca275d047c90c0c7d5afb13ab97efdf51bd6e	   refs/tags/v0.99.3

AUTHOR

       Written by Junio C Hamano <gitster@pobox.com[1]>

GIT

       Part of the git(1) suite

NOTES

	1. gitster@pobox.com
	   mailto:gitster@pobox.com

Git 1.7.1							    07/05/2010							  GIT-LS-REMOTE(1)
Man Page