Skip to content

Commit

Permalink
Update man file descriptions and add content.
Browse files Browse the repository at this point in the history
  • Loading branch information
mmcgr committed Mar 30, 2017
1 parent 43da663 commit d2ae713
Show file tree
Hide file tree
Showing 5 changed files with 38 additions and 75 deletions.
30 changes: 16 additions & 14 deletions man/souffle-compile.1
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.TH SOUFFLE-COMPILE 1 2016-03-25
.TH SOUFFLE-COMPILE 1 2017-03-30

.SH NAME
.B souffle-compile - short description of souffle-compile
.SH SYNOPSIS
.B souffle-compile
.SH SYNOPSIS
.B Compile a C++ source file generated by souffle
[
.I options
]
Expand All @@ -12,22 +12,24 @@
.B Long description of souffle-compile
.SH OPTIONS
.TP
.B -h, --help
show a help page.
.B -h
show usage.
.B -s
compile a program with OpenMP support
.TP
.B -v
verbose output
.TP
.B -w
enable warnings
.TP

.SH EXAMPLES

.B souffle-compile ...

souffle-compile [options] <FILE>.cpp
.SH VERSION

1.0
1.1

.SH LICENSE

Copyright (c) 2013, 2015, Oracle and/or its affiliates.
All rights reserved.
Copyright (c) 2016 Oracle and/or its affiliates. All Rights reserved.

.SH SEE ALSO
\fBg++\fP(1), \fBjava\fP(1)
17 changes: 7 additions & 10 deletions man/souffle-config.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH SOUFFLE-CONFIG 1 2016-03-25
.TH SOUFFLE-CONFIG 1 2017-03-30

.SH NAME
.B souffle-config - short description of souffle-config
Expand All @@ -12,22 +12,19 @@
.B Long description of souffle-config
.SH OPTIONS
.TP
.B -h, --help
.B -h
show a help page.
.TP

.SH EXAMPLES

.B souffle-config ...
.B -l
list the libraries needed to compile with souffle.
.TP

.SH VERSION

1.0
1.1

.SH LICENSE

Copyright (c) 2013, 2015, Oracle and/or its affiliates.
All rights reserved.
Copyright (c) 2016 Oracle and/or its affiliates. All Rights reserved.

.SH SEE ALSO
\fBg++\fP(1), \fBjava\fP(1)
18 changes: 8 additions & 10 deletions man/souffle-profile.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH SOUFFLE-PROFILE 1 2016-03-25
.TH SOUFFLE-PROFILE 1 2017-03-30

.SH NAME
.B souffle-profile
Expand All @@ -20,29 +20,27 @@ generated by Souffle programs that were are compiled with the
option -p.
.SH OPTIONS
.TP
.B -h, --help
.B -h
show a help page.
.TP
.B -f\fI<filename>\fP
specifies the profile filename
.B -v
print the profiler version
.TP
.B -c\fI<command>\fP
executes the command and terminates the profiler after execution.
If no command is specief, the interactive mode is enabled.
Run -c "help" for a list of profiler commands.
.B -l
enable profiling of a running program
.SH EXAMPLES

.B souffle-profile -f prof.log
.B souffle-profile -v | -h | <log-file> [ -c <command> | -j | -l ]

.SH VERSION

1.0
1.1

.SH LICENSE

Copyright (c) 2013, 2015, Oracle and/or its affiliates.
All rights reserved.
Copyright (c) 2016 Oracle and/or its affiliates. All Rights reserved.

.SH SEE ALSO
\fBg++\fP(1), \fBjava\fP(1)
30 changes: 0 additions & 30 deletions man/souffle-wave.1

This file was deleted.

18 changes: 7 additions & 11 deletions man/souffle.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH SOUFFLE 1 2016-03-25
.TH SOUFFLE 1 2017-03-30

.SH NAME
.B souffle
Expand All @@ -10,8 +10,8 @@
]
.I files
.SH DESCRIPTION
Souffle is used as a domain-specific language for static program analysis, over
large code bases with millions of lines of code. Souffle aims at producing
Souffle is used as a domain-specific language for static program analysis over
large code bases with millions of lines of code. Souffle aims to produce
high-performance C++ code that can be compiled with the native compiler on the
target machine.
.SH OPTIONS
Expand All @@ -25,12 +25,8 @@ verbose output
.B -F\fI<DIR>\fP, --fact-dir=\fI<DIR>\fP
specify directory for fact files
.TP
.TP
.B -I\fI<DIR>\fP, --include-dir=\fI<DIR>\fP
specify directory for include files
.TP
.B -D\fI<DIR>\fP, --output-dir-dir=\fI<DIR>\fP
Specify directory for output relations (if \fI<DIR>\fP is -, output is written to stdout)
.B -D\fI<DIR>\fP, --output-dir=\fI<DIR>\fP
Specify directory for output relations (if \fI<DIR>\fP is -, all output is written to stdout)
.TP
.B -j\fI<N>\fP, --jobs=\fI<N>\fP
run interpreter/compiler in parallel using N threads, N=auto for system default
Expand All @@ -55,8 +51,8 @@ write debugging output to HTML report
.SH EXAMPLES
souffle program.dl
.SH VERSION
1.0
1.1
.SH LICENSE
Copyright (c) 2013, 2015, Oracle and/or its affiliates. All rights reserved.
Copyright (c) 2016 Oracle and/or its affiliates. All Rights reserved.
.SH SEE ALSO
\fBg++\fP(1), \fBjava\fP(1)

0 comments on commit d2ae713

Please sign in to comment.