Function: beginning-of-line

beginning-of-line is an interactive function defined in cmds.c.

Signature

(beginning-of-line &optional N)

Documentation

Move point to beginning of current line (in the logical order).

With argument N not nil or 1, move forward N - 1 lines first. If point reaches the beginning or end of buffer, it stops there.

This function constrains point to the current field unless this moves point to a different line from the original, unconstrained result. If N is nil or 1, and a front-sticky field starts at point, the point does not move. To ignore field boundaries bind inhibit-field-text-motion to t, or use the forward-line function instead. For instance, (forward-line 0) does the same thing as
(beginning-of-line), except that it ignores field boundaries.

View in manual

Probably introduced at or before Emacs version 20.4.

Key Bindings

Aliases

eshell-bol (obsolete since 30.1) widget-beginning-of-line

Source Code

// Defined in /usr/src/emacs/src/cmds.c
{
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
    CHECK_FIXNUM (n);

  SET_PT (XFIXNUM (Fline_beginning_position (n)));

  return Qnil;
}