| Summary: | ConsoleKit needs man pages | ||
|---|---|---|---|
| Product: | ConsoleKit | Reporter: | Brian Cameron <brian.cameron> |
| Component: | Daemon | Assignee: | william.jon.mccann |
| Status: | NEW --- | QA Contact: | |
| Severity: | normal | ||
| Priority: | medium | CC: | halton.huo |
| Version: | unspecified | ||
| Hardware: | Other | ||
| OS: | All | ||
| Whiteboard: | |||
| i915 platform: | i915 features: | ||
| Attachments: |
bzip2 tarball of manpages for ConsoleKit: ConsoleKit-man.tar.bz2
all manapages catt'ed together in a single text file for easier review, if desired |
||
Created attachment 30859 [details]
all manapages catt'ed together in a single text file for easier review, if desired
Comment on attachment 30859 [details] all manapages catt'ed together in a single text file for easier review, if desired Thanks for doing this. Some comments follow. >User Commands ck-history(1) > > > >NAME > ck-history - ConsoleKit history > >SYNOPSIS > ck-history [--frequent] [--help] [--last] [--last-compat] > [--log] [--seat=_s_e_a_t] [--session-type=_t_y_p_e] [--user=_u_s_e_r] > [--version] What is up with the strange characters there? >DESCRIPTION > ck-history is a utility that provides information from the > ConsoleKit database about what users have logged into the > system. It supports options to specify whether to provide > information about users who have logged in most frequently > or most recently. > > The ck-history utility is used by gdm(1m) when the GDM Face > Browser is enabled to display users in the order of fre- > quency. > >OPTIONS > The following options are supported: > > --frequent Show listing of logged-in > users in the most frequent > order. > > > 3 lines of whitespace seems excessive. > -h, --help Display detailed usage mes- > sage. Two spaces after usage seems odd though I guess this is to justify the text. Is it required? I guess so - just seems odd. > > > > --last Show listing of logged-in > users in the most-recent > order. > > > "Show listing of all user logins since logging began in the most-recent order." or something like that. > --last-compat Show listing of logged-in > users in the most-recent > order. The output is > displayed in last(1) compa- > tible format. > > > > --log Show full ConsoleKit event > log. > > > > > > >SunOS 5.11 Last change: 22 Oct 2009 1 > > > > > > >User Commands ck-history(1) > > > > -s, --seat=_s_e_a_t Show entries for the speci- > fied _s_e_a_t. Odd chars again. > > > -t, --session-type=_t_y_p_e Show entries for the speci- > fied session _t_y_p_e. > Ditto > > -u, --user=_u_s_e_r Show entries for the speci- > fied _u_s_e_r. > > Ditto > -V, --version Display the version of the > ck-history application. > > > >EXAMPLES > Example 1: Show most frequently logged in users > > example% ck-history --frequent > > Example 2: Show the entire ConsoleKit log. > > example% ck-history --log > >FILES > The following files are used by this application: > > /usr/bin/ck-history > > Executable for ConsoleKit history. > It seems odd to list this. > > /var/log/ConsoleKit/history > > ConsoleKit history database. > > > >ATTRIBUTES > See attributes(5) for descriptions of the following attri- > butes: > > > > > > > > >SunOS 5.11 Last change: 22 Oct 2009 2 > > > > > > >User Commands ck-history(1) > > > > ____________________________________________________________ > | ATTRIBUTE TYPE | ATTRIBUTE VALUE | > |______________________________|______________________________| > | Availability | SUNWconsolekit | > |______________________________|______________________________| > | Interface stability | Volatile | > |______________________________|______________________________| Not applicable upstream. > >SEE ALSO > ck-launch-session(1), ck-list-sessions(1), ck-seat-tool(1m), > console-kit-daemon(1m), gdm(1m), attributes(5) seat-tool has to go. >NOTES > Written by Brian Cameron, Sun Microsystems Inc., 2009. > Copyright (c) 2009 by Sun Microsystems, Inc. >NAME > ck-launch-session - ConsoleKit session launcher This name is misleading. >SYNOPSIS > ck-launch-session _c_o_m_m_a_n_d Chars again. Cribbing from the dbus-launch man page: "Utility to start a ConsoleKit session from a shell script" Also, command is optional. If not specified it launches a shell. >DESCRIPTION > ck-launch-session is a utility for starting a command in its > own ConsoleKit session. This would be useful if a user > wanted to start their own session via a startx script and > have it registered with ConsoleKit, for example. > >OPERANDS > The following operands are supported: > > _c_o_m_m_a_n_d Start the specified _c_o_m_m_a_n_d in its own Con- > soleKit session. Chars again. Also see note above about when command is not given. > > >EXAMPLES > Example 1: Launch the startx command in its own ConsoleKit > session > > example% ck-launch-session startx Probably show when no command is given too. >FILES > The following files are used by this application: > > /usr/bin/ck-launch-session > > Executable for ConsoleKit session launcher. This doesn't seem necessary. > > >ATTRIBUTES > See attributes(5) for descriptions of the following attri- > butes: > > ____________________________________________________________ > | ATTRIBUTE TYPE | ATTRIBUTE VALUE | > |______________________________|______________________________| > | Availability | SUNWconsolekit | > |______________________________|______________________________| > | Interface stability | Volatile | > |______________________________|______________________________| n/a > >SEE ALSO > ck-history(1), ck-list-sessions(1), ck-seat-tool(1m), > console-kit-daemon(1m), gdm(1m), attributes(5) > Drop seat-tool. > >User Commands ck-list-sessions(1) > > > >NAME > ck-list-sessions - Show ConsoleKit Session Information > >SYNOPSIS > ck-list-sessions [--all] [--format=_f_o_r_m_a_t] [--help] [-- > version] chars again. Weird wrap with the --version? >DESCRIPTION > ck-list-sessions is a utility that displays information from > the ConsoleKit database. By default, only open sessions are > shown. The --all option can be used to display all existing > sessions on the system. ck-list-sessions returns informa- > tion about each ConsoleKit session. Users can specify which > properties to display via the --format option. > > The following properties can be displayed for each session: > >OPTIONS > The following options are supported: > > -a, --all Show all ConsoleKit sessions. If > this option is not provided, only > open sessions are shown. > > > > -f, --format=_f_o_r_m_a_t Display information using the speci- > fied _f_o_r_m_a_t. The _f_o_r_m_a_t value is a > list of properties to display > separated by commas. This is a good idea but doesn't exist in master right? Why isn't it in master? > > > -h, --help Display detailed usage message. > > > > -V, --version Display the version of the ck-list- > sessions application. > > The following stuff isn't in master. >EXTENDED DESCRIPTION > ConsoleKit session properties > For each session, the following session properties are > displayed: > > unix-user The user id value associated with > the session. > > > > > > >SunOS 5.11 Last change: 22 Oct 2009 1 > > > > > > >User Commands ck-list-sessions(1) > > > > realname The name of the user associated with > the session. > > > > seat The ID for the ConsoleKit Seat asso- > ciated with the session. > > > > session-type The ConsoleKit session type. This > value is specified by the "Type" key > in the ConsoleKit session configura- > tion file associated with this ses- > sion. > > > display-type The ConsoleKit display type. This > value is specified by the "Display- > Template" key in the ConsoleKit ses- > sion configuration file associated > with this session. > This doesn't exist in master. > > open The value is "TRUE" if the session > is open, and "FALSE" otherwise. > > > > active The value is "TRUE" if the session > is active on the seat to which it is > attached, and "FALSE" otherwise. > > > > x11-display The value of the X11 DISPLAY > environment variable for this ses- > sion if one is present. > > > > x11-display-device The value of the display device that > the X11 display for the session is > connected to. If there is no x11- > display set, then this value is > undefined. > > > > > > > >SunOS 5.11 Last change: 22 Oct 2009 2 > > > > > > >User Commands ck-list-sessions(1) > > > > display-device The display device associated with > the session. > > > > remote-host If the session is not local, the > value is the host name associated > with the session. If the session is > local, the value is empty. > > > > is-local The value is "TRUE" if the session > is local, and "FALSE" if remote. > > > > on-since An ISO 8601 date-time string that > corresponds to the time the session > started. > > > > login-session-id The value of the login session ID > that the underlying system uses to > enforce session boundaries. If there > is no login session ID set then this > value is an empty string. > > > > idle-since-hint An ISO 8601 date-time string that > corresponds to the time of the last > change of the idle-hint. This is a > hint used to indicate that the ses- > sion may be idle. For sessions with > a x11-display set (ie. graphical > sessions), it is up to each session > to delegate the responsibility for > updating this value. Typically, the > screensaver will set this. > > However, for non-graphical sessions > with a display-device set the Ses- > sion object itself will periodically > update this value based on the > activity detected on the display- > device itself. > > This should not be considered > authoritative. > > > > >SunOS 5.11 Last change: 22 Oct 2009 3 > > > > > > >User Commands ck-list-sessions(1) > > > >EXAMPLES > Example 1: Show running sessions. > > example% ck-list-sessions > > This command would generate output like the following for > each session: > > SessionSeat1Local: > unix-user = '50' > realname = 'GDM Reserved UID' > seat = 'Seat1' > session-type = 'LoginWindow' > display-type = 'Local' > open = 'TRUE' > active = 'TRUE' > x11-display = ':0' > x11-display-device = '/dev/console' > display-device = '/dev/console' > remote-host-name = '' > is-local = 'TRUE' > on-since = '2009-08-11T06:46:42.941134Z' > login-session-id = '' > idle-since-hint = '' Some of this isn't in master. > Example 2: Show only the session-id, unix-user, and > display-type properties. > > example% ck-list-sessions --format="session-id,unix-user,display-type" > > This command would generate output like the following for > each session: > > SessionSeat1Local 50 Local Again. >FILES > The following files are used by this application: > > /usr/bin/ck-list-sessions > > Executable for Show ConsoleKit Session Information. No need for this. > > > /etc/ConsoleKit/session.d > > ConsoleKit session configuration files. > Not in master. > > See attributes(5) for descriptions of the following attri- > butes: > > ____________________________________________________________ > | ATTRIBUTE TYPE | ATTRIBUTE VALUE | > |______________________________|______________________________| > | Availability | SUNWconsolekit | > |______________________________|______________________________| > | Interface stability | Volatile | > |______________________________|______________________________| n/a >SEE ALSO > ck-history(1), ck-launch-session(1), ck-seat-tool(1m), > console-kit-daemon(1m), gdm(1m), attributes(5) Again. This is not in master: >NAME > ck-seat-tool - ConsoleKit seat tool >Maintenance Commands console-kit-daemon(1m) > > > >NAME > console-kit-daemon - ConsoleKit daemon > >SYNOPSIS > console-kit-daemon [--debug] [--help] [--no-daemon] [-- > timed-exit] Weird wrap. >DESCRIPTION Maybe a link to the web page too? > console-kit-daemon is a utility for defining and tracking s/utility/service/. > users, login sessions and seats. It provides interfaces for > managing switching sessions and session migration when using > mechanisms such as Virtual Terminals (VT). ConsoleKit pro- not called VTs on Linux. probably needs a link to console(4). > vides a number of interfaces to specify what displays are > managed by the display manager, and how. > > ConsoleKit maintains a database of which users are logged > into the system. ConsoleKit groups sessions by seats which and a history of all user logins. > represent a set of hardware (usually a keyboard and mouse). > Other process communicate with ConsoleKit via D-Bus. Need a link to the d-bus man page? > One session leader process is responsible for asking > console-kit-daemon to open a new session. In the typical > case, the session leader would be a ConsoleKit enabled > display manager, such as GDM. This leader makes a connec- > tion to the D-Bus system bus and asks console-kit-daemon to > open a session when needed. The session leader isn't GDM per-se. It is just the first process of the new session - the one that registers. The one that we use to automatically gather information about the session. And the one process whose lifecycle we track. > If the operation succeeds, console-kit-daemon will return a > cookie to the session leader. The session leader should > store this variable in the environment as XDG_SESSION_COOKIE > so that it may be shared with its child processes. The > environment variable contains the UUID used to tie processes > to a session. > > At this point the session will be registered with ConsoleKit > and a particular set of information about the session will > be stored along with it. > > The Session will remain open until the Session Leader > disconnects from the D-Bus system bus. The session will be > removed from its seat, and deregistered. > > Various other programs need to know information about run- > ning user sessions, such as the Fast User Switch Applet and > other mechanisms for switching the console to use a dif- Better to say GDM here or just leave it open. FUSA is obsolete. > ferent VT display. Such programs make use of ConsoleKit > interfaces to determine if user switching is supported and > to manage the switching of different sessions on the same > seat. > > On Solaris, the ConsoleKit service is managed by the smf(5) > service management facility under the service identifier n/a > > >SunOS 5.11 Last change: 24 Oct 2009 1 > > > > > > >Maintenance Commands console-kit-daemon(1m) > > > > _s_v_c:/_s_y_s_t_e_m/_c_o_n_s_o_l_e_k_i_t. On Solaris, it is recommended that > you use the svcadm(1m) utility to start and stop the Con- > soleKit service. > > ConsoleKit provides a pam_ck_connector so that non-graphical > logins (e.g. telnet, ssh, etc.) are registered with Con- > soleKit. This functionality works if this PAM module is > enabled in the pam.conf(4) configuration. Thus ConsoleKit > can be used as a utmp/wtmp replacement since it stores a > superset of the information as in the utmp/wtmp database. > > The ConsoleKit database is stored in the file > /var/run/ConsoleKit/database. It stores information about > active Seats, Sessions, and the current SessionLeader. > >OPTIONS > The following options are supported: > > --debug Enable debug output. > > > > -h, --help Display detailed usage message. > > > > --no-daemon Avoid starting console-kit-daemon as > a daemon. Useful for debugging. > > > > --timed-exit Exit after 30 seconds. Useful for > debugging. > > > >ENVIRONMENT VARIABLES > See environ(5) for descriptions of environment variables. > > DISPLAY > > This environment variable corresponds to the Xserver > display value associated with the ConsoleKit session. > > > > XDG_SESSION_COOKIE > > ConsoleKit provides this environment variable to the > session leader. The session leader is expected to > ensure this is set for the session process started. It > contains a UUID used to tie the processes to the > > > >SunOS 5.11 Last change: 24 Oct 2009 2 > > > > > > >Maintenance Commands console-kit-daemon(1m) > > > > session. This is used to support user switching on > displays that support it (currently only graphical VT > displays on the console). > > > > The following environment variables are set when console- > kit-daemon runs the run-session.d and run-seat.d scripts. > These values correspond to those values returned by the ck- > list-session(1) utility. Hmm, run-session is deprecated maybe don't list it? > CK_SESSION_SEAT_ID > > The seat ID associated with the session. > > > > CK_SESSION_SEAT_UID > > The user id associated with the session > > > > CK_SESSION_DISPLAY_DEVICE > > The display device associated with the session. > > > > CK_SESSION_X11_DISPLAY_DEVICE > > The value of the display device that the X11 display for > the session is connected to. If there is no x11-display > set, then this value is undefined. > > > > CK_SESSION_X11_DISPLAY > > The value of the X11 DISPLAY environment variable for > this session if one is present. > > > > CK_SESSION_REMOTE_HOST_NAME > > If the session is not local, the value is the host name > associated with the session. If the session is local, > the value is empty. > > > > > > >SunOS 5.11 Last change: 24 Oct 2009 3 > > > > > > >Maintenance Commands console-kit-daemon(1m) > > > > CK_SESSION_IS_ACTIVE > > The value is "TRUE" if the session is active on the seat > to which it is attached, and "FALSE" otherwise. > > > > CK_SESSION_IS_LOCAL > > The value is "TRUE" if the session is local, and "FALSE" > if remote. > > > > CK_SESSION_IS_DYNAMIC > > The value is "TRUE" if the session was started with ck- > seat-tool, and "FALSE" otherwise. > The above variables aren't right for run-seat.d I think. > >EXTENDED DESCRIPTION > ConsoleKit Seat Configuration > ConsoleKit seat configuration files are located in the > /etc/ConsoleKit/seats.d directory. Each seat configuration > file ends with the .seat suffix. ConsoleKit provides a > default seat file named 00-primary.seat. Additional seat > configuration files may be added. These files are in stan- > dard INI format. > > The settings below are in "group/key=_d_e_f_a_u_l_t__v_a_l_u_e" format, > and show the default values of the 00-primary.seat file. > For example, to specify a different "Seat Entry/Name" value, > you would modify the this file so it contains these lines: > > [Seat Entry] > [...] > Name=Customized seat name > > The following keys are supported for configuring ConsoleKit > seats: > > Seat Entry/Version=1.0 > > Version number of the seat file. This specifies the > version number of the configuration file format used. > Currently only the value "1.0" is supported. > > > > Seat Entry/Name=Primary seat > > > > >SunOS 5.11 Last change: 24 Oct 2009 4 > > > > > > >Maintenance Commands console-kit-daemon(1m) > > > > Name of the seat. > > > > Seat Entry/ID=StaticSeat > > Specifies the unique ID of the seat. If the value is > NULL, then console-kit-daemon will provide a value. The > ID may only contain the ASCII characters [A-Z][a=z][0- > 9]_". > > > > Seat Entry/Hidden=false > > If this value is set to "false", then ConsoleKit will > create this seat. Otherwise, the seat will not be > created. > > > > Seat Entry/Devices > > This value is not currently supported. In the future, > it is planned that ConsoleKit will provide the ability > to manage how device permissions are managed, and this > key is a placeholder. > > > > Seat Entry/Sessions=Local > > List of sessions to start on the seat, separated by the > ";" character. Each session must be defined in a Con- > soleKit session configuration file named > /etc/ConsoleKit/sessions.d/_s_e_s_s_i_o_n_s.session where _s_e_s_- > _s_i_o_n_s is the value of this key. > Drop this for master. > > ConsoleKit Display Configuration > ConsoleKit display configuration files are located in the > /etc/ConsoleKit/displays.d directory. Each session confi- > guration file ends with the .display suffix. Additional > seat configuration files may be added. These files are in > standard INI format. > > The settings below are in "group/key" format, so to specify > the "X11/Display" value, the file shoulld contain these > lines: > Drop this for master. > > > >SunOS 5.11 Last change: 24 Oct 2009 5 > > > > > > >Maintenance Commands console-kit-daemon(1m) > > > > [X11] > [...] > Exec=/usr/X11/bin/Xorg $display -br -verbose -auth $auth -nolisten tcp $vt > > The following keys are supported for configuring ConsoleKit > displays: > > Display/Type > > The type of the display. Currently only the value "X11" > is supported. This indicates that the display will be > managed by an Xserver that sends a SIGUSR1 signal to its > parent pid when it is ready. This is standard for all > Xservers, such as the Xorg(1) Xserver. > > > > X11/Exec > > The command to run to launch the session. This command > supports variables that start with the "$" character, > like "$display". The values to use for these variables > can either be specified in the ConsoleKit session confi- > guration file in the "[Local]" section, or via the ck- > seat-tool(1) application. > Drop for master. > > ConsoleKit Session Configuration > ConsoleKit session configuration files are located in the > /etc/ConsoleKit/sessions.d directory. Each session confi- > guration file ends with the .session suffix. Additional > seat configuration files may be added. These files are in > standard INI format. > > The settings below are in "group/key" format, so to specify > the "Session Entry/Name" value, the file shoulld contain > these lines: > > [Session Entry] > [...] > Name=Customized Session > > The following keys are supported for configuring ConsoleKit > sessions: > > Session Entry/Name > > Unique name of the session. > > > > > > >SunOS 5.11 Last change: 24 Oct 2009 6 > > > > > > >Maintenance Commands console-kit-daemon(1m) > > > > Session Entry/Type > > Type of the session > > > > Session Entry/Description > > Description of the session. > > > > Session Entry/DisplayTemplate > > This specifies the display type to be used with the ses- > sion. This corresponds to the file > /etc/ConsoleKit/displays.d/_d_i_s_p_l_a_y__t_e_m_p_l_a_t_e.display > where _d_i_s_p_l_a_y__t_e_m_p_l_a_t_e is the value of this key. > > > > Local/_v_a_r_i_a_b_l_e > > The ConsoleKit display configuration file associated > with the "Entry/DisplayTemplate" key specifies the com- > mand to run to launch the display. This command is > defined in the ConsoleKit display configuration file in > the key "X11/Exec". This command can include variables > that begin with the "$" character, such as "$display". > The values to be used for these variables can be defined > in this section. So if the session configuration file > contains the value "Local/display=:0", this will cause > the variable used when launching the command to be > replaced with the value "0". Drop for master. > > > ConsoleKit Session Script Interfaces > The following interfaces are provided so that system > administrators can configure that certain actions happen > when ConsoleKit responds to certain events. > > When a ConsoleKit session is started or removed, then > console-kit-daemon will first run any scripts found in the > /etc/ConsoleKit/run-session.d directory and then run any > scripts in the /usr/lib/ConsoleKit/run-session.d directory. > > When certain seat events, such as "seat_added", > "seat_removed" or "seat_active_session_changed" occur, then > console-kit-daemon will first run any script in the > /etc/ConsoleKit/run-seat.d directory and then run any > scripts in the /usr/lib/ConsoleKit/run-seat.d directory. > This is out of date. > >SunOS 5.11 Last change: 24 Oct 2009 7 > > > > > > >Maintenance Commands console-kit-daemon(1m) > > > > ConsoleKit System Restart and Stop > console-kit-daemon provides D-Bus interfaces that will res- > tart or stop the system. When console-kit-daemon receives a > D-Bus request to restart the system, it will run the > /usr/lib/ConsoleKit/scripts/ck-system-restart script if the > user has privilege to do this operation. When console-kit- > daemon receives a D-Bus request to stop the system, it will > run the /usr/lib/ConsoleKit/scripts/ck-system-stop script if > the user has privilege to do this operation. > >EXAMPLES > Example 1: To start the ConsoleKit daemon > > example% console-kit-daemon > > Example 2: To configure ConsoleKit to start multiple ses- > sions on a single seat > > To start two local displays: DISPLAY ":0" on vt7 and DISPLAY > ":1" on "vt8", edit the 00-primary.seat file as follows: > > [Seat Entry] > Version=1.0 > Name=Primary seat > Description=start static displays :0 on vt7 and :1 on vt8 > Hidden=false > Devices= > Sessions=Local;Local2; > > Then, in addition to the original > /etc/ConsoleKit/sessions.d/Local.session file, add the fol- > lowing /etc/ConsoleKit/sessions.d/Local2.session file: > > [Session Entry] > Name=Local > Type=LoginWindow > Description=Local Login Screen > DisplayTemplate=Local > > [Local] > display=:1 > vt=/dev/vt/8 > > Example 3: To configure ConsoleKit to start multiple seat > > To start two seats: a local session on DISPLAY ":0" using > "vt7" and another seat using a VNC session on DISPLAY ":64", > add a file /etc/ConsoleKit/seats.d/01-vnc.seat as follows: > > [Seat Entry] > Version=1.0 > Name=VNC seat > Drop for master. > >SunOS 5.11 Last change: 24 Oct 2009 8 > > > > > > >Maintenance Commands console-kit-daemon(1m) > > > > Description=start one VNC display on :64 > Hidden=false > Devices= > Sessions=LocalVNC; > > Add the /etc/ConsoleKit/sessions.d/LocalVNC.session file as > follows: > > [Session Entry] > Name=LocalVNC > Type=LoginWindow > Description=Connect to local VNC server running on same machine > DisplayTemplate=LocalVNC > > [LocalVNC] > display=:64 > > Finally, add the /etc/ConsoleKit/displays.d/LocalVNC.display > file as follows: > > [Display] > Type=X11 > > [X11] > Exec=/usr/X11/bin/Xvnc $display -auth $auth -query localhost Drop for master. >FILES > The following files are used by this application: > > /usr/sbin/console-kit-daemon > > Executable for the ConsoleKit daemon. Drop. > > > /usr/lib/ConsoleKit/run-seat.d > > Any scripts in this directory are run when a ConsoleKit > seat event happens. > > > > /usr/lib/ConsoleKit/run-session.d > > Any scripts in this directory are run when a ConsoleKit > session event happens. Maybe drop? > > > /usr/lib/ConsoleKit/scripts/ck-system-restart > > Script to run when ConsoleKit receives a D-Bus request > > > >SunOS 5.11 Last change: 24 Oct 2009 9 > > > > > > >Maintenance Commands console-kit-daemon(1m) > > > > to restart the system. > > > > /usr/lib/ConsoleKit/scripts/ck-system-stop > > Script to run when ConsoleKit receives a D-Bus request > to stop the system. > > > > /etc/ConsoleKit/seats.d > > ConsoleKit seat configuration files. > Drop for master. > > /etc/ConsoleKit/session.d > > ConsoleKit session configuration files. > Ditto > > /etc/ConsoleKit/run-seat.d > > Any scripts in this directory are run when a ConsoleKit > seat event happens. > List with /lib run-seat.d above. > > /etc/ConsoleKit/run-session.d > > Any scripts in this directory are run when a ConsoleKit > seat event happens. > Ditto > > /var/run/ConsoleKit/database > > ConsoleKit database. > > > > /var/log/ConsoleKit/history > > ConsoleKit history database. > > > >ATTRIBUTES > See attributes(5) for descriptions of the following attri- > butes: > > > >SunOS 5.11 Last change: 24 Oct 2009 10 > > > > > > >Maintenance Commands console-kit-daemon(1m) > > > > ____________________________________________________________ > | ATTRIBUTE TYPE | ATTRIBUTE VALUE | > |______________________________|______________________________| > | Availability | SUNWconsolekit | > |______________________________|______________________________| > | Interface stability | Volatile | > |______________________________|______________________________| n/a > >SEE ALSO > More information can be found at: > > http://www.freedesktop.org/wiki/Software/ConsoleKit > > ck-history(1), ck-launch-session(1), ck-list-sessions(1), > ck-seat-tool(1m), gdm(1m), svcadm(1m), attributes(5), > environ(5), smf(5) Drop seat-tool >NOTES > Brian Cameron, Sun Microsystems Inc., 2009. Copyright (c) > 2009 by Sun Microsystems, Inc. > > Some of the documentation in this manpage is from the Con- > soleKit documentation written by William Jon McCann. Jon: Thanks for your review. Some comments: 1) Sorry that the text file contains the messy characters. This is because when you run "man foo > foo.txt", underlined characters get saved with the escape sequences. If you download the file and view the file with "cat", it will show properly, but it doesn't when you just view via your web browser. 2) White space issues are controlled by "man". You don't have any real control over how vertical white space is managed. Extra spaces are added automatically by man to justify things - you can't really control this. You can control how things word wrap to a degree (typically by rewording the sentence to avoid the word wrap). 3) On Solaris, it is a requirement to list the binary itself in the FILES section. This can be removed for the upstream version. I agree this is a dumb requirement, but the Solaris version of the manpages will probably include this. No problem removing other Solaris-specific things (such as the ATTRIBUTES) section, but I will refrain from doing this until we get all the other issues resolved. I'd rather not do the work to remove these sections multiple times for each round of review. I'd rather do it once after we get the text pretty much solid, as I said before. 4) I should have been more clear that these manpages were written for the code *after* Multi-Seat logic is added. Many of your comments seem to suggest that we should rework the manpages to reflect the current code. I would prefer to wait to add the manpages until after the MultiSeat code lands. Why do extra work to remove the Multi-Seat related documentation and add it back later? At the Boston Summit, you and Ray seemed to agree that the MultiSeat features will land in the next release cycle anyway. >>NAME >> ck-launch-session - ConsoleKit session launcher > > This name is misleading. Can you recommend something better? >> users, login sessions and seats. It provides interfaces for >> managing switching sessions and session migration when using >> mechanisms such as Virtual Terminals (VT). ConsoleKit pro- > > not called VTs on Linux. probably needs a link to console(4). Could you suggest better text? > Need a link to the d-bus man page? I can add this to the console-kit-daemon SEE ALSO section. >> One session leader process is responsible for asking >> console-kit-daemon to open a new session. In the typical >> case, the session leader would be a ConsoleKit enabled >> display manager, such as GDM. This leader makes a connec- >> tion to the D-Bus system bus and asks console-kit-daemon to >> open a session when needed. > > The session leader isn't GDM per-se. It is just the first process of the new > session - the one that registers. The one that we use to automatically gather > information about the session. And the one process whose lifecycle we track. I am not sure how you want the above paragraph to be modified. It already says that GDM is just an example. Also, I believe this text is pretty much the same as in the general ConsoleKit documentation. > Hmm, run-session is deprecated maybe don't list it? Should we just remove all references to run-session? > The above variables aren't right for run-seat.d I think. Can someone let me know for sure. Should the entire environment variable section regarding "environment variables used when running scripts" just be removed? >> Seat Entry/Sessions=Local >> >> List of sessions to start on the seat, separated by the >> ";" character. Each session must be defined in a Con- >> soleKit session configuration file named >> /etc/ConsoleKit/sessions.d/_s_e_s_s_i_o_n_s.session >> where _s_e_s_- >> _s_i_o_n_s is the value of this key. >> > > Drop this for master. What do you mean by "this" exactly? >> ConsoleKit Display Configuration >> >> ConsoleKit display configuration files are located in the >> /etc/ConsoleKit/displays.d directory. Each session confi- > > guration file ends with the .display suffix. Additional > > seat configuration files may be added. These files are in > > standard INI format. >> >> The settings below are in "group/key" format, so to specify >> the "X11/Display" value, the file shoulld contain these >> lines: >> > > Drop this for master. Again, what are you referring to exactly? >> When certain seat events, such as "seat_added", >> "seat_removed" or "seat_active_session_changed" occur, then >> console-kit-daemon will first run any script in the >> /etc/ConsoleKit/run-seat.d directory and then run any >> scripts in the /usr/lib/ConsoleKit/run-seat.d directory. >> > > This is out of date. Can you provide better text, or explain what is out of date. Do you just mean that the run-session stuff should be removed? Jon, since you seem to have concerns about how white space is handled, you might want to download the tarball and just copy the NROFF files into your /usr/share/man/man1 directory (for the files that end in ".1") and the /usr/share/man/man1m directory (for the files that end in ".1m"). Then you can just run "man (programname)" to see how it renders on your system. I'd imagine "man" probably renders differently on Solaris than Linux. |
Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.
Created attachment 30852 [details] bzip2 tarball of manpages for ConsoleKit: ConsoleKit-man.tar.bz2 ConsoleKit needs manpages for the binaries it ships to /usr/bin and /usr/sbin. The attached bzip2 tarball provides the manpages I wrote for inclusion on Solaris for ConsoleKit. The tarball contains the manpages in three formats (SGML, NROFF, and plain text). The plain text version is for easier review. I'm not sure if it makes more sense to integrate the SGML or NROFF versions of the manpages, so I provided both. Note the console-kit-daemon contains one sentence about Solaris-specific features (its usage of smf). Also these manpages include a Solaris-specific "ATTRIBUTES" section, which should probably be removed when these are added, though that is easy enough. Just delete the lines for those sections. I am happy to remove the ATTRIBUES and/or the Solaris-specific comments if desired, but I wanted people to review them first since I'd rather make any improvements to them before doing that.