summaryrefslogtreecommitdiff
path: root/sd_login/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'sd_login/doc.go')
-rw-r--r--sd_login/doc.go38
1 files changed, 38 insertions, 0 deletions
diff --git a/sd_login/doc.go b/sd_login/doc.go
new file mode 100644
index 0000000..ba1a0f7
--- /dev/null
+++ b/sd_login/doc.go
@@ -0,0 +1,38 @@
+// Copyright (C) 2016 Luke Shumaker <lukeshu@sbcglobal.net>
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// Package sd_login TODO
+//
+// The login manager manages 4 basic object types
+//
+// - machine: A container or virtual machine
+//
+// - seat: A set of hardware devices for a workspace; ie a screen
+// and keyboard
+//
+// - session: A login session; tied to 0 or 1 seats (0 for things
+// like SSH login)
+//
+// - user: Keeps track of logged in users; that is, users with 1 or
+// more sessions
+//
+// TODO: why are machines part of this?
+//
+// - pid: A process may belong to a session, or directly to a user if
+// it is not part of a session. This "belonging" is separate
+// accounting by the login manager; it is NOT the same as the
+// EUID/RUID.
+//
+// - peer: A peer is a process on the other end of a AF_UNIX socket.
+package sd_login