Add IRI support
[elpher.git] / elpher.texi
index 268bdf4..5892db3 100644 (file)
@@ -1,7 +1,7 @@
 \input texinfo @c -*-texinfo-*-
 
 @setfilename elpher.info
-@settitle Elpher Manual v3.1.0
+@settitle Elpher Manual v3.2.2
 
 @dircategory Emacs
 @direntry
@@ -667,7 +667,7 @@ preference of the community.)
 @node Local files, About pages, Finger support, Top
 @chapter Local files
 
-Elpher supports opening local files via @code{file:} URLs.
+Elpher supports opening local files via @samp{file:} URLs.
 
 For instance, pressing @key{g} and entering @code{file:~/document.gmi}
 will load the file named @samp{document.gmi} in your home directory,
@@ -703,6 +703,10 @@ much that elpher can sensibly do with unknown binary files.)
 
 @end table
 
+Gophermap files (i.e. files containing literally the intended output of
+querying a directory selector according to RFC 1436) cannot yet rendered
+using @samp{file:}.
+
 
 @node About pages, Customization, Local files, Top
 @chapter About pages
@@ -735,13 +739,13 @@ to display buffer headers, how to deal with ANSI escape sequences in
 text, the timeout to impose on network connections, and whether to
 prompt for confirmation when switching away from TLS.
 
-One particularly important customization is the @code{elpher-start-page}
+One particularly important customization is the @code{elpher-start-page-url}
 variable, which holds the URL of the page displayed initially when
 elpher starts, and when @key{U} is pressed.  By default this is set to
 @samp{about:welcome}, but any URL can be substituted.  For example, you
 might want to create a text/gemini file named
 @samp{~/.emacs/start-page.gmi} containing useful links and set the value
-of @code{elpher-start-page} to @samp{file:~/.emacs/start-page.gmi} to have
+of @code{elpher-start-page-url} to @samp{file:~/.emacs/start-page.gmi} to have
 these links displayed at startup.  Alternatively, you might prefer
 to set the value to @samp{about:bookmarks} so that the bookmarks page
 is used as the start page instead.
@@ -760,12 +764,30 @@ This chapter documents the major changes introduced by Elpher releases.
 
 @section v3.2.0
 
+This version introduces several minor changes which, together, make it
+possible to set up alternative start pages configured to your liking.
+
 @subsection About pages
 
+Special elpher pages such as the welcome page (previously ``start''
+page), the bookmarks page, the browsing history stack and list of
+visited pages are now addressible via @samp{about:} URLs.  For instance,
+the standard welcome page has the address @samp{about:welcome}.
+
 @subsection Local files
 
+Local files can now be opened in elpher using @samp{file:} URLs. For
+example, @kbd{g @samp{file:~/my-start.gmi}} will open
+@samp{~/my-start.gmi} as a text/gemini document. @pxref{Local files}
+for details.
+
 @subsection Customizable start pages
 
+The new customization variable @code{elpher-start-page-url} contains the URL
+of the document to be loaded as elpher's ``start page''.  By default
+this is set to @samp{about:welcome}, but any elpher-accessible URL is
+valid. @pxref{Customization} for suggestions.
+
 @section v3.1.0
 
 @subsection Bookmarks system