Permalink
Browse files

Minor changes to the info manual. Thanks to Xah Lee.

  • Loading branch information...
1 parent f37b899 commit abe9e09165657e80cd57a788d59769cf41ab4633 @melmothx melmothx committed Nov 27, 2008
@@ -0,0 +1,82 @@
+// Persistence of Vision Ray Tracer Scene Description File
+// File: ?.pov
+// Vers: 3.6
+// Desc: Basic Scene Template with desert and clouds
+// Date: mm/dd/yy
+// Auth: ?
+//
+
+#version 3.6;
+#include "colors.inc"
+
+global_settings { assumed_gamma 1.0
+ max_trace_level 20
+ noise_generator 1
+}
+
+camera { angle 80
+ location <0,3,-15>
+ look_at <0,6,0>
+}
+
+light_source { <3000,5000,-3500> White }
+
+plane { y,10000 hollow
+ texture { pigment
+ {color rgb < 0.05, 0.25, 0.6> }
+ finish
+ {ambient 1 diffuse 0}
+ }
+}
+
+plane {
+ y,-3
+ texture {
+ pigment { Coral }
+ normal { agate }
+ finish { phong 0.1 }
+ }
+}
+
+plane { y, 1 hollow
+ texture {
+ pigment {
+ bozo turbulence 0.65
+ octaves 6 omega 0.7 lambda 2
+ color_map {
+ [0 color rgbt <0.95,0.95,0.95, 0.2>]
+ [0.1 color rgbt <0.8,0.86,0.86,0.3>]
+ [0.5 color rgbt 1]
+ [1 color rgbt 1]
+ }
+ rotate <10,20,0>
+ scale <0.9,1.2,0.6>
+ }
+ finish { ambient 1 diffuse 0 }
+ }
+ scale 1000
+}
+
+plane { y, 1 hollow
+ texture {
+ pigment {
+ bozo turbulence 0.85
+ octaves 7 omega .65 lambda 2.5
+ color_map {
+ [0 color rgbt <0.95,0.95,0.95,0.5>]
+ [0.1 color rgbt <0.85,0.85,0.85,0.4>]
+ [0.3 color rgbt 1]
+ [1 color rgbt 1]
+ }
+ rotate <10,20,0>
+ scale <1.9,1.2,0.6>
+ }
+ finish { ambient 1 diffuse 0 }
+ scale 2
+ }
+ scale 900
+}
+fog { distance 300000 color White } // a bit of fog
+
+
+
@@ -0,0 +1,39 @@
+// Persistence of Vision Ray Tracer Scene Description File
+// File: ?.pov
+// Vers: 3.6
+// Desc: Basic Scene Example with sky and sea
+// Date: mm/dd/yy
+// Auth: ?
+//
+
+#version 3.6;
+#include "textures.inc"
+#include "colors.inc"
+
+global_settings { assumed_gamma 1.0 }
+#default{ finish{ ambient 0.1 diffuse 0.9 }}
+
+
+
+camera {
+ location <2, 1.5, -15>
+ look_at <20, 3.5, 3>
+}
+light_source { <-150, 300, -300> color White}
+
+
+plane { y, -0.95
+ texture{ Polished_Chrome
+ normal{ bumps 0.25 scale <0.25,0.25,0.25>*0.5 turbulence 0.5 }
+ finish{ reflection 0.60 }}}
+
+sky_sphere { pigment
+ { gradient <0,1,0>
+ color_map { [0.00 rgb <0.6,0.7,1.0>]
+ [0.35 rgb <0.0,0.1,0.8>]
+ [0.65 rgb <0.0,0.1,0.8>]
+ [1.00 rgb <0.6,0.7,1.0>]
+ }
+ scale 2
+ } // end of pigment
+} //end of skysphere
View
@@ -1,3 +1,25 @@
+DOCUMENTATION
+
+To access the pov-mode.info file, start Emacs and type C-u C-h i RET.
+This will prompt you for a file: give the pov-mode.info file that you
+can find in the pov-mode.el directory. Or install it somewhere in your
+INFOPATH and run install-info pov-mode.info dir.
+
+The source of pov-mode.info is in the info directory. So, if you have
+a decent TeX installation you can give the command
+
+texi2pdf --clean pov-mode.texi
+
+and print it as pdf. Or
+
+makeinfo --html pov-mode.texi
+
+and create a HTML doc directory.
+So you can skip the rest of this file and read
+the *real* documentation.
+
+
+
INSTALLATION
Step 1: Adding the load-path and auto-mode setup.
@@ -83,3 +105,4 @@ FEATURES
To learn about the basics of using pov-mode, open a pov file and press
C-h m.
+
View
@@ -1,9 +1,9 @@
\input texinfo @c -*-texinfo-*-
@c %**start of header
@setfilename pov-mode.info
-@settitle The pov-mode manual, version 0.1
+@settitle The pov-mode manual, version 02
@set VERSION 3.2
-@set UPDATED 24 May 2008
+@set UPDATED 26 May 2008
@c @syncodeindex pg cp
@c %**end of header
@@ -54,7 +54,7 @@ Documentation License''.
* Installation::
* Getting started::
* The menu-bar::
-* tools ::
+* tools ::
* Copying This Manual::
@detailmenu
@@ -164,12 +164,10 @@ need this step.
@node InsertMenu, Include and docs, Compilation, Installation
@section Get the InsertMenu tree (optional)
-The nice feature of the @file{InsertMenu} is not provided with the
-@file{pov-mode} tarball for copyright reasons. The @file{InsertMenu}
-directory is shipped as a separate package, because is covered by the
-POV-Ray license and may be used by anyone eligible to use POV-Ray
-according to this license. Even if POV-Ray is not considered strictly
-free software, it cannot be considered proprietary software.
+@file{pov-mode} provides a GUI menu @samp{InsertMenu} with over 200
+templates files (inc files, and templates for color, lighting, shape,
+transformation ...etc). However, these templates are not bundled for
+licening issues.
I suggest you to unpack the tarball in the same directory of
@file{pov-mode.el}, so you don't need anything else.
@@ -197,7 +195,7 @@ for Future Sessions}. In both case restart Emacs. @xref{Insert menu}.
To use @file{pov-mode.el} at its full power you need to tell it where
can find the includes and the documentation of POV-Ray. You can do this
as you have done for the @code{pov-insertmenu-location}, by writing
-the code yourself or by using @code{customize}. The variable are:
+the code yourself or by using @kbd{customize-group @key{RET} pov @key{RET}}. The variable are:
@table @code
@item pov-include-dir
@@ -270,8 +268,8 @@ One click on a item will move the point to that. It can be useful
editing large files with a lot of declarations and macros, or to jump
fast to the camera.
-It's safe to use but can be disable setting
-@code{pov-imenu-only-macros} to @code{t} (e.g. via @code{customize}), which
+It's safe to use but can be disable by setting
+@code{pov-imenu-only-macros} to @code{t} (e.g. via @kbd{customize-group @key{RET} pov @key{RET}}), which
disable everything but the macros; @code{pov-imenu-in-menu} to
@code{nil} will disable this feature at all.
@@ -283,7 +281,7 @@ It use the library @file{imenu.el}.
The @code{Insert} menu exists only if you installed the
@file{InsertMenu} tree somewhere. @xref{InsertMenu}. It contains a
-large collection of shapes, object, whole scenes templates, etc. Just
+large collection of shapes, objects, whole scenes templates, etc. Just
click to insert the object.
I'll provide you just a pair of sample files. However you can use this
@@ -294,7 +292,7 @@ number.
For example, suppose @file{myscene_template.pov} is your template
file, and you want to add it under the menu "Insert:Scene Template".
Rename your file to @file{01 - my scene.txt} (please note the spaces
-and the digit), then place it in the directory @file{InsertMenu/00 - Scene
+and the digits), then place it in the directory @file{InsertMenu/00 - Scene
templates}, then restart Emacs. Then, your scene template file will
appear as the first item in the menu @samp{Insert:Scene Template}.
@@ -305,7 +303,7 @@ on. Just look at the sample files. I suggest to remove them, get the
@file{povray-imenu-3.6.tar.gz} (by Christoph Hormann and others) at
@uref{http://www.imagico.de/imenu/povray-imenu-3.6.tar.gz} or
@uref{http://xahlee.org/emacs/povray-imenu-3.6.tar.gz}, or build your
-on templates.
+own templates.
@@ -321,12 +319,19 @@ in progress.
The arguments passed to @command{povray} are fully customizable and
have an incremental quality. So these command are self-explanatory.
-Use @code{customize} to change the value of the quality, e.g. adding
+Use @kbd{customize-group @key{RET} pov @key{RET}} to change the value of the quality, e.g. adding
switches, please remember to preserve the @code{%s}, which will be
substituted by the file name. The menu-bar items are also bound to a
keystroke:
@table @kbd
+
+@item C-c C-c r
+(@kbd{M-x pov-tool-bar-command-render})
+
+Run @command{povray} without argument (default quality depending on
+your settings.
+
@item C-c C-c 1
(@kbd{M-x pov-menu-render-test})
@@ -366,7 +371,7 @@ buffer) or external (using an external command).
(@code{pov-menu-external-viewer})
Use the program set by @samp{Pov External Viewer Command} in
- @code{customize} (@code{pov-external-viewer-command})
+ @kbd{customize-group @key{RET} pov @key{RET}} (@code{pov-external-viewer-command})
@item C-c C-c v
(@kbd{M-x pov-menu-internal-viewer})
@@ -407,7 +412,9 @@ are bound to a keystroke:
@end table
The following items are not bound because are command shared with
-other modes, so someone would like to bound it globally.
+other modes, so someone would like to bound it globally. You can use
+the @kbd{M-x comment-dwim} to comment or uncomment region). Usually is
+bound to @kbd{M-;}.
@table @samp
@@ -469,7 +476,7 @@ The default paths are the default in the installation of the binary
distribution of POV-Ray. So, if you have POV-Ray installed somewhere
else you have to set these variables to a valid location.
-Please use @code{customize} to set these variables.
+Please use @kbd{customize-group @key{RET} pov @key{RET}} to set these variables.
@node include-file, universal, keyword-help, tools
@section Opening the include files
View
@@ -6,7 +6,7 @@
;; Author: Peter Boettcher <pwb@andrew.cmu.edu>
;; Maintainer: Marco Pessotto <marco.erika@gmail.com>
;; Created: 04 March 1994
-;; Modified: 24 May 2008
+;; Modified: 26 May 2008
;; Version: 3.2
;; Keywords: pov, povray
;;
@@ -64,6 +64,10 @@
;; Type M-x byte-compile-file.
;;
;; To read pov-mode documentation, type M-x pov-mode then C-h m.
+;; To access the pov-mode info file type C-u C-h i RET. This will
+;; prompt you for a file: give the pov-mode.info file that you can
+;; find in the pov-mode.el directory. Or install somewhere in your
+;; INFOPATH and run install-info pov-mode.info dir.
;;
;; Download and install somewhere the InsertMenu directory, if you
;; want this nice feature. I'd recommend you to unpack it in the same
@@ -283,6 +287,8 @@
;; Fixed a minor #macro indenting bug
;; 2008-05-24 Version 3.2
;; Written the texinfo manual. No code improvement (sorry)
+;; 2008-05-26
+;; Minor changes to the info manual. Thanks to Xah Lee.
;;
;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;

0 comments on commit abe9e09

Please sign in to comment.