comparison src/handle.rs @ 91:039aae9a01f7

Improve documentation on TTY functions.
author Paul Fisher <paul@pfish.zone>
date Wed, 18 Jun 2025 16:30:41 -0400
parents f6186e41399b
children 5ddbcada30f2
comparison
equal deleted inserted replaced
90:f6186e41399b 91:039aae9a01f7
136 item = "PAM_USER_PROMPT", 136 item = "PAM_USER_PROMPT",
137 see = Self::user_prompt 137 see = Self::user_prompt
138 ); 138 );
139 139
140 trait_item!( 140 trait_item!(
141 /// "The terminal name prefixed by /dev/ for device files." 141 /// The device path of the TTY being used to log in.
142 /// 142 ///
143 /// This is the terminal the user is logging in on. 143 /// This is the terminal the user is logging in on,
144 /// specified as the full device path (e.g. `/dev/tty0`).
144 /// Very old applications may use this instead of `PAM_XDISPLAY`. 145 /// Very old applications may use this instead of `PAM_XDISPLAY`.
145 get = tty_name, 146 get = tty_name,
146 item = "PAM_TTY" 147 item = "PAM_TTY"
147 ); 148 );
148 trait_item!( 149 trait_item!(
149 /// Sets the terminal name. 150 /// Sets the path to the terminal where the user is logging on.
150 ///
151 /// (TODO: See if libpam sets this itself or if the application does.)
152 set = set_tty_name, 151 set = set_tty_name,
153 item = "PAM_TTY", 152 item = "PAM_TTY",
154 see = Self::tty_name 153 see = Self::tty_name
155 ); 154 );
156 155