Skip to content

Commit

Permalink
doc: add explanations of OB_RANDOM_SEED environment variable
Browse files Browse the repository at this point in the history
TODO: please comment them in if OpenBabel 4.0.0 is released
  • Loading branch information
e-kwsm committed Aug 17, 2022
1 parent 0ebc8e6 commit f62b547
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 0 deletions.
6 changes: 6 additions & 0 deletions doc/obabel.1
Expand Up @@ -520,6 +520,12 @@ For further specific information and options, use
.Fl H Ar format-type ,
e.g.,
.Fl Hcml
\"\" TODO comment in if OB 4.0.0 is released
\".Sh ENVIRONMENT
\".Bl -tag -width flag
\".It Ev OB_RANDOM_SEED
\"Seed for pseudo random number generator. If unset or null, random seed is used.
\".El
.Sh EXAMPLES
Standard conversion:
.Dl "obabel ethanol.xyz \-Oethanol.pdb"
Expand Down
6 changes: 6 additions & 0 deletions doc/obdistgen.1
Expand Up @@ -9,6 +9,12 @@
.Ar filename
.Sh DESCRIPTION
Generates SDFs with distance geometry.
\"\" TODO comment in if OB 4.0.0 is released
\".Sh ENVIRONMENT
\".Bl -tag -width flag
\".It Ev OB_RANDOM_SEED
\"Seed for pseudo random number generator. If unset or null, random seed is used.
\".El
.Sh EXAMPLES
.Dl "obdistgen molecule.smi > molecule.sdf"
.Pp
Expand Down
6 changes: 6 additions & 0 deletions doc/obgen.1
Expand Up @@ -24,6 +24,12 @@ will give all options including the available forcefields.
.It Fl ff Ar forcefield
Select the forcefield
.El
\"\" TODO comment in if OB 4.0.0 is released
\".Sh ENVIRONMENT
\".Bl -tag -width flag
\".It Ev OB_RANDOM_SEED
\"Seed for pseudo random number generator. If unset or null, random seed is used.
\".El
.Sh EXAMPLES
.Pp
View the possible options, including available forcefields:
Expand Down
6 changes: 6 additions & 0 deletions doc/obrotamer.1
Expand Up @@ -17,6 +17,12 @@ rotamers are not conformers -- that is,
does not perform geometry optimization after generating the rotamer
structure. The obminimize tool can do geometry optimization using
molecular mechanics.
\"\" TODO comment in if OB 4.0.0 is released
\".Sh ENVIRONMENT
\".Bl -tag -width flag
\".It Ev OB_RANDOM_SEED
\"Seed for pseudo random number generator. If unset or null, random seed is used.
\".El
.Sh EXAMPLES
.Dl "obrotamer baseconformer.sdf > rotamer1.sdf"
.Pp
Expand Down

0 comments on commit f62b547

Please sign in to comment.