aboutsummaryrefslogtreecommitdiffstats
path: root/src/README
diff options
context:
space:
mode:
authorMattias Andrée <maandree@member.fsf.org>2015-12-28 16:16:07 +0100
committerMattias Andrée <maandree@member.fsf.org>2015-12-28 16:16:07 +0100
commit8e8ae43531b3e7f52cb6dc2f81e139926decac66 (patch)
tree3e48535a756b8b322d4ffbc9904c9e83c2b72053 /src/README
parenttypo (diff)
downloadsat-8e8ae43531b3e7f52cb6dc2f81e139926decac66.tar.gz
sat-8e8ae43531b3e7f52cb6dc2f81e139926decac66.tar.bz2
sat-8e8ae43531b3e7f52cb6dc2f81e139926decac66.tar.xz
a file guide
Signed-off-by: Mattias Andrée <maandree@member.fsf.org>
Diffstat (limited to 'src/README')
-rw-r--r--src/README19
1 files changed, 19 insertions, 0 deletions
diff --git a/src/README b/src/README
new file mode 100644
index 0000000..541907e
--- /dev/null
+++ b/src/README
@@ -0,0 +1,19 @@
+sat.c The satd program, ask satd to queue a job.
+satq.c The satq program, ask satd for a list of queued jobs.
+satr.c The satr program, ask satd to run jobs early.
+satrm.c The satrm program, ask satd to remove jobs from the queue.
+
+satd.c The initialisation part of satd.
+satd-diminished.c The rest of satd, std.c exec:s to this.
+
+parse_time.[ch] Use by sat.c to parse the time argument.
+ Only rudimentary parsing is done.
+
+daemonise.[ch] From <http://github.com/maandree/slibc>;
+ daemonisation of the process. Used by satd.c
+
+client.[ch] Used by sat{,q,r,rm}.c, code for communicating
+ with satd, starts satd transparently if necessary.
+
+common.h Used by sat{,q,r,rm}.c, some shared code.
+