Skip to content

Commit

Permalink
Editing .rst files
Browse files Browse the repository at this point in the history
  • Loading branch information
dmorse committed May 12, 2016
1 parent 9069259 commit 7e5a7e3
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 28 deletions.
18 changes: 8 additions & 10 deletions doc/user-man/binary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,13 @@ be able to open it in the future by double-clicking it just as you can
any registered app.

When the pscf_terminal application opens a yellow terminal window, it
it modifies the unix executable search path so as to allow the operating
system to find the pscf executable when pscf is invoked from within the
yellow terminal. It does not, however, modify the user environment in
a way that would allow pscf to be invoked from another terminal. If you
have installed pscf using the .dmg installer file but would like to be
able to run it from the command line of any terminal (as for most unix
commands) follow the instructions given in the discussion of
:ref:`install-compile-cmake-paths` regarding how to modify up your shell
configuration files to accomplish this.
also modifies the unix executable search path used in that window so
as to allow the pscf command to be found when invoked from that window.
This does not, however, allow pscf to be invoked from another terminal.
If you install pscf using the .dmg installer file but would also like
to be able to run it from the command line of any terminal (like any
other unix commands), follow the instructions given in the discussion
of :ref:`install-compile-cmake-paths-sub`.

Ubuntu or Debian Linux
----------------------
Expand Down Expand Up @@ -127,6 +125,6 @@ of a different package file format and package manager. In this case:

> sudo rpm -Uvh pscf-<version>-Linux.rpm

* Confirm that the executable has been installed in /usr/local/bin/,
* Confirm that the executable has been installed in /usr/local/bin,
following the instructions given above for a .deb package.

37 changes: 19 additions & 18 deletions doc/user-man/compile-make.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,37 +12,38 @@ unix environments is the locations of the required libraries.

To compile the code in this way, proceed as follows:

* Follow the directions given in the subsection of the previous
page entitled :ref:`install-compile-cmake-dependencies-sub` in order
to install dependencies on your operating systems. Install all
required dependencies except cmake.
* Follow the directions given in the discussion of
:ref:`install-compile-cmake-dependencies-sub` on the previoius
page. You will need to install all dependencies listed there
except cmake.

* Follow the directions given in the subsection of the previous
page entitled :ref:`install-compile-cmake-getsource-sub` in order
to obtain the source code and create a directory structure.
* Follow the directions given in the preceding discussion of
:ref:`install-compile-cmake-getsource-sub` to obtain the source
code and create an appropriate directory structure.

* Change the working directory (cd) to the pscf/git/make directory.
Note that this is an existing subdirectory of the pscf/git directory,
and is different from the initially empty pscf/cmake directory from
which we suggested that you should invokve cmake, if compiling with
cmake.
* Change the working directory (cd) to the directory pscf/git/make in
the directory structure described in the instructions for compiling
with cmake. Note that this is an existing subdirectory of the
pscf/git directory, and is different from the initially empty
pscf/cmake directory from which we recommended that invoke cmake
when using cmake to generate makefiles.

* This directory should contain files named config.mk_r and Makefile.
Make a copy of the file config.mk_r, by entering::
* The pscf/git/make directory will contain files named config.mk_r
and Makefile. Make a copy of the file config.mk_r, by entering::

cd config.mk_r config.mk

* Examine and edit the new config.mk file to reflect your environment,
and to specify an installation directory. The need to manually edit
this configuration file is the main difference between using cmake
to and using make alone. See below for further instructions about
this step.
to generate makefiles and using the simple makefile distributed with
the source code. See below for further instructions about this step.

* To compile, enter::

> make -j4 all

from within pscf/git/make.
from within pscf/git/make. The "-j4" option is not necessary.

* To install in the directory specified by the $(INSTALL) makefile
variable (as defined in config.mk), enter::
Expand All @@ -53,7 +54,7 @@ To compile the code in this way, proceed as follows:
page entitled :ref:`install-compile-cmake-paths-sub` in order
to modify environment variables that define search paths.

Some of these steps are discussed in more detail below.
Several of these steps are discussed in more detail below.

**Editing the config.mk configfuration file**

Expand Down

0 comments on commit 7e5a7e3

Please sign in to comment.