diff options
| author | Richard M. Stallman | 2001-11-22 13:04:54 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 2001-11-22 13:04:54 +0000 |
| commit | e428626af94c09febba893210bf59d9a20cc594b (patch) | |
| tree | 38d994fbb974b4d4c0e50cf52cc2b5ad4c4470c7 | |
| parent | 82f6e63d7c21a51e1b329305b2ea905fdfd906ca (diff) | |
| download | emacs-e428626af94c09febba893210bf59d9a20cc594b.tar.gz emacs-e428626af94c09febba893210bf59d9a20cc594b.zip | |
Some nodes moved back from xresources.texi.
| -rw-r--r-- | man/cmdargs.texi | 420 |
1 files changed, 420 insertions, 0 deletions
diff --git a/man/cmdargs.texi b/man/cmdargs.texi index f518fefd7ad..b2fa0647867 100644 --- a/man/cmdargs.texi +++ b/man/cmdargs.texi | |||
| @@ -60,6 +60,13 @@ the action arguments in the order they are written. | |||
| 60 | * Command Example:: Examples of using command line arguments. | 60 | * Command Example:: Examples of using command line arguments. |
| 61 | * Resume Arguments:: Specifying arguments when you resume a running Emacs. | 61 | * Resume Arguments:: Specifying arguments when you resume a running Emacs. |
| 62 | * Environment:: Environment variables that Emacs uses. | 62 | * Environment:: Environment variables that Emacs uses. |
| 63 | * Display X:: Changing the default display and using remote login. | ||
| 64 | * Font X:: Choosing a font for text, under X. | ||
| 65 | * Colors X:: Choosing colors, under X. | ||
| 66 | * Window Size X:: Start-up window size, under X. | ||
| 67 | * Borders X:: Internal and external borders, under X. | ||
| 68 | * Title X:: Specifying the initial frame's title. | ||
| 69 | * Icons X:: Choosing what sort of icon to use, under X. | ||
| 63 | @end menu | 70 | @end menu |
| 64 | 71 | ||
| 65 | @node Action Arguments | 72 | @node Action Arguments |
| @@ -528,3 +535,416 @@ actually used. | |||
| 528 | @item WINDOW_GFX | 535 | @item WINDOW_GFX |
| 529 | Used when initializing the Sun windows system. | 536 | Used when initializing the Sun windows system. |
| 530 | @end table | 537 | @end table |
| 538 | |||
| 539 | @node Display X | ||
| 540 | @appendixsec Specifying the Display Name | ||
| 541 | @cindex display name (X Window System) | ||
| 542 | @cindex @env{DISPLAY} environment variable | ||
| 543 | |||
| 544 | The environment variable @env{DISPLAY} tells all X clients, including | ||
| 545 | Emacs, where to display their windows. Its value is set by default | ||
| 546 | in ordinary circumstances, when you start an X server and run jobs | ||
| 547 | locally. Occasionally you may need to specify the display yourself; for | ||
| 548 | example, if you do a remote login and want to run a client program | ||
| 549 | remotely, displaying on your local screen. | ||
| 550 | |||
| 551 | With Emacs, the main reason people change the default display is to | ||
| 552 | let them log into another system, run Emacs on that system, but have the | ||
| 553 | window displayed at their local terminal. You might need to log in | ||
| 554 | to another system because the files you want to edit are there, or | ||
| 555 | because the Emacs executable file you want to run is there. | ||
| 556 | |||
| 557 | The syntax of the @env{DISPLAY} environment variable is | ||
| 558 | @samp{@var{host}:@var{display}.@var{screen}}, where @var{host} is the | ||
| 559 | host name of the X Window System server machine, @var{display} is an | ||
| 560 | arbitrarily-assigned number that distinguishes your server (X terminal) | ||
| 561 | from other servers on the same machine, and @var{screen} is a | ||
| 562 | rarely-used field that allows an X server to control multiple terminal | ||
| 563 | screens. The period and the @var{screen} field are optional. If | ||
| 564 | included, @var{screen} is usually zero. | ||
| 565 | |||
| 566 | For example, if your host is named @samp{glasperle} and your server is | ||
| 567 | the first (or perhaps the only) server listed in the configuration, your | ||
| 568 | @env{DISPLAY} is @samp{glasperle:0.0}. | ||
| 569 | |||
| 570 | You can specify the display name explicitly when you run Emacs, either | ||
| 571 | by changing the @env{DISPLAY} variable, or with the option @samp{-d | ||
| 572 | @var{display}} or @samp{--display=@var{display}}. Here is an example: | ||
| 573 | |||
| 574 | @smallexample | ||
| 575 | emacs --display=glasperle:0 & | ||
| 576 | @end smallexample | ||
| 577 | |||
| 578 | You can inhibit the direct use of the window system and GUI with the | ||
| 579 | @samp{-nw} option. It tells Emacs to display using ordinary ASCII on | ||
| 580 | its controlling terminal. This is also an initial option. | ||
| 581 | |||
| 582 | Sometimes, security arrangements prevent a program on a remote system | ||
| 583 | from displaying on your local system. In this case, trying to run Emacs | ||
| 584 | produces messages like this: | ||
| 585 | |||
| 586 | @smallexample | ||
| 587 | Xlib: connection to "glasperle:0.0" refused by server | ||
| 588 | @end smallexample | ||
| 589 | |||
| 590 | @noindent | ||
| 591 | You might be able to overcome this problem by using the @code{xhost} | ||
| 592 | command on the local system to give permission for access from your | ||
| 593 | remote machine. | ||
| 594 | |||
| 595 | @node Font X | ||
| 596 | @appendixsec Font Specification Options | ||
| 597 | @cindex font name (X Window System) | ||
| 598 | |||
| 599 | By default, Emacs displays text in the font named @samp{9x15}, which | ||
| 600 | makes each character nine pixels wide and fifteen pixels high. You can | ||
| 601 | specify a different font on your command line through the option | ||
| 602 | @samp{-fn @var{name}} (or @samp{--font}, which is an alias for | ||
| 603 | @samp{-fn}). | ||
| 604 | |||
| 605 | @table @samp | ||
| 606 | @item -fn @var{name} | ||
| 607 | @opindex -fn | ||
| 608 | @itemx --font=@var{name} | ||
| 609 | @opindex --font | ||
| 610 | @cindex specify default font from the command line | ||
| 611 | Use font @var{name} as the default font. | ||
| 612 | @end table | ||
| 613 | |||
| 614 | Under X, each font has a long name which consists of eleven words or | ||
| 615 | numbers, separated by dashes. Some fonts also have shorter | ||
| 616 | nicknames---@samp{9x15} is such a nickname. You can use either kind of | ||
| 617 | name. You can use wildcard patterns for the font name; then Emacs lets | ||
| 618 | X choose one of the fonts that match the pattern. Here is an example, | ||
| 619 | which happens to specify the font whose nickname is @samp{6x13}: | ||
| 620 | |||
| 621 | @smallexample | ||
| 622 | emacs -fn "-misc-fixed-medium-r-semicondensed--13-*-*-*-c-60-iso8859-1" & | ||
| 623 | @end smallexample | ||
| 624 | |||
| 625 | @noindent | ||
| 626 | You can also specify the font in your @file{.Xdefaults} file: | ||
| 627 | |||
| 628 | @smallexample | ||
| 629 | emacs.font: -misc-fixed-medium-r-semicondensed--13-*-*-*-c-60-iso8859-1 | ||
| 630 | @end smallexample | ||
| 631 | |||
| 632 | A long font name has the following form: | ||
| 633 | |||
| 634 | @smallexample | ||
| 635 | -@var{maker}-@var{family}-@var{weight}-@var{slant}-@var{widthtype}-@var{style}@dots{} | ||
| 636 | @dots{}-@var{pixels}-@var{height}-@var{horiz}-@var{vert}-@var{spacing}-@var{width}-@var{charset} | ||
| 637 | @end smallexample | ||
| 638 | |||
| 639 | @table @var | ||
| 640 | @item maker | ||
| 641 | This is the name of the font manufacturer. | ||
| 642 | @item family | ||
| 643 | This is the name of the font family---for example, @samp{courier}. | ||
| 644 | @item weight | ||
| 645 | This is normally @samp{bold}, @samp{medium} or @samp{light}. Other | ||
| 646 | words may appear here in some font names. | ||
| 647 | @item slant | ||
| 648 | This is @samp{r} (roman), @samp{i} (italic), @samp{o} (oblique), | ||
| 649 | @samp{ri} (reverse italic), or @samp{ot} (other). | ||
| 650 | @item widthtype | ||
| 651 | This is normally @samp{condensed}, @samp{extended}, @samp{semicondensed} | ||
| 652 | or @samp{normal}. Other words may appear here in some font names. | ||
| 653 | @item style | ||
| 654 | This is an optional additional style name. Usually it is empty---most | ||
| 655 | long font names have two hyphens in a row at this point. | ||
| 656 | @item pixels | ||
| 657 | This is the font height, in pixels. | ||
| 658 | @item height | ||
| 659 | This is the font height on the screen, measured in tenths of a printer's | ||
| 660 | point---approximately 1/720 of an inch. In other words, it is the point | ||
| 661 | size of the font, times ten. For a given vertical resolution, | ||
| 662 | @var{height} and @var{pixels} are proportional; therefore, it is common | ||
| 663 | to specify just one of them and use @samp{*} for the other. | ||
| 664 | @item horiz | ||
| 665 | This is the horizontal resolution, in pixels per inch, of the screen for | ||
| 666 | which the font is intended. | ||
| 667 | @item vert | ||
| 668 | This is the vertical resolution, in pixels per inch, of the screen for | ||
| 669 | which the font is intended. Normally the resolution of the fonts on | ||
| 670 | your system is the right value for your screen; therefore, you normally | ||
| 671 | specify @samp{*} for this and @var{horiz}. | ||
| 672 | @item spacing | ||
| 673 | This is @samp{m} (monospace), @samp{p} (proportional) or @samp{c} | ||
| 674 | (character cell). | ||
| 675 | @item width | ||
| 676 | This is the average character width, in pixels, multiplied by ten. | ||
| 677 | @item charset | ||
| 678 | This is the character set that the font depicts. | ||
| 679 | Normally you should use @samp{iso8859-1}. | ||
| 680 | @end table | ||
| 681 | |||
| 682 | @cindex listing system fonts | ||
| 683 | You will probably want to use a fixed-width default font---that is, | ||
| 684 | a font in which all characters have the same width. Any font with | ||
| 685 | @samp{m} or @samp{c} in the @var{spacing} field of the long name is a | ||
| 686 | fixed-width font. Here's how to use the @code{xlsfonts} program to | ||
| 687 | list all the fixed-width fonts available on your system: | ||
| 688 | |||
| 689 | @example | ||
| 690 | xlsfonts -fn '*x*' | egrep "^[0-9]+x[0-9]+" | ||
| 691 | xlsfonts -fn '*-*-*-*-*-*-*-*-*-*-*-m*' | ||
| 692 | xlsfonts -fn '*-*-*-*-*-*-*-*-*-*-*-c*' | ||
| 693 | @end example | ||
| 694 | |||
| 695 | @noindent | ||
| 696 | To see what a particular font looks like, use the @code{xfd} command. | ||
| 697 | For example: | ||
| 698 | |||
| 699 | @example | ||
| 700 | xfd -fn 6x13 | ||
| 701 | @end example | ||
| 702 | |||
| 703 | @noindent | ||
| 704 | displays the entire font @samp{6x13}. | ||
| 705 | |||
| 706 | While running Emacs, you can set the font of the current frame | ||
| 707 | (@pxref{Frame Parameters}) or for a specific kind of text | ||
| 708 | (@pxref{Faces}). | ||
| 709 | |||
| 710 | @node Colors X | ||
| 711 | @appendixsec Window Color Options | ||
| 712 | @cindex color of window | ||
| 713 | @cindex text colors, from command line | ||
| 714 | |||
| 715 | @findex list-colors-display | ||
| 716 | @cindex available colors | ||
| 717 | On a color display, you can specify which color to use for various | ||
| 718 | parts of the Emacs display. To find out what colors are available on | ||
| 719 | your system, type @kbd{M-x list-colors-display}, or press | ||
| 720 | @kbd{C-Mouse-2} and select @samp{Display Colors} from the pop-up menu. | ||
| 721 | If you do not specify colors, on windowed displays the default for the | ||
| 722 | background is white and the default for all other colors is black. On a | ||
| 723 | monochrome display, the foreground is black, the background is white, | ||
| 724 | and the border is gray if the display supports that. On terminals, the | ||
| 725 | background is usually black and the foreground is white. | ||
| 726 | |||
| 727 | Here is a list of the command-line options for specifying colors: | ||
| 728 | |||
| 729 | @table @samp | ||
| 730 | @item -fg @var{color} | ||
| 731 | @opindex -fg | ||
| 732 | @itemx --foreground-color=@var{color} | ||
| 733 | @opindex --foreground-color | ||
| 734 | @cindex foreground color, command-line argument | ||
| 735 | Specify the foreground color. @var{color} should be a standard color | ||
| 736 | name, or a numeric specification of the color's red, green, and blue | ||
| 737 | components as in @samp{#4682B4} or @samp{RGB:46/82/B4}. | ||
| 738 | @item -bg @var{color} | ||
| 739 | @opindex -bg | ||
| 740 | @itemx --background-color=@var{color} | ||
| 741 | @opindex --background-color | ||
| 742 | @cindex background color, command-line argument | ||
| 743 | Specify the background color. | ||
| 744 | @item -bd @var{color} | ||
| 745 | @opindex -bd | ||
| 746 | @itemx --border-color=@var{color} | ||
| 747 | @opindex --border-color | ||
| 748 | @cindex border color, command-line argument | ||
| 749 | Specify the color of the border of the X window. | ||
| 750 | @item -cr @var{color} | ||
| 751 | @opindex -cr | ||
| 752 | @itemx --cursor-color=@var{color} | ||
| 753 | @opindex --cursor-color | ||
| 754 | @cindex cursor color, command-line argument | ||
| 755 | Specify the color of the Emacs cursor which indicates where point is. | ||
| 756 | @item -ms @var{color} | ||
| 757 | @opindex -ms | ||
| 758 | @itemx --mouse-color=@var{color} | ||
| 759 | @opindex --mouse-color | ||
| 760 | @cindex mouse pointer color, command-line argument | ||
| 761 | Specify the color for the mouse cursor when the mouse is in the Emacs window. | ||
| 762 | @item -r | ||
| 763 | @opindex -r | ||
| 764 | @itemx -rv | ||
| 765 | @opindex -rv | ||
| 766 | @itemx --reverse-video | ||
| 767 | @opindex --reverse-video | ||
| 768 | @cindex reverse video, command-line argument | ||
| 769 | Reverse video---swap the foreground and background colors. | ||
| 770 | @end table | ||
| 771 | |||
| 772 | For example, to use a coral mouse cursor and a slate blue text cursor, | ||
| 773 | enter: | ||
| 774 | |||
| 775 | @example | ||
| 776 | emacs -ms coral -cr 'slate blue' & | ||
| 777 | @end example | ||
| 778 | |||
| 779 | You can reverse the foreground and background colors through the | ||
| 780 | @samp{-rv} option or with the X resource @samp{reverseVideo}. | ||
| 781 | |||
| 782 | The @samp{-fg}, @samp{-bg}, and @samp{-rv} options function on | ||
| 783 | text-only terminals as well as on window systems. | ||
| 784 | |||
| 785 | @node Window Size X | ||
| 786 | @appendixsec Options for Window Geometry | ||
| 787 | @cindex geometry of Emacs window | ||
| 788 | @cindex position and size of Emacs frame | ||
| 789 | @cindex width and height of Emacs frame | ||
| 790 | |||
| 791 | The @samp{--geometry} option controls the size and position of the | ||
| 792 | initial Emacs frame. Here is the format for specifying the window | ||
| 793 | geometry: | ||
| 794 | |||
| 795 | @table @samp | ||
| 796 | @item -g @var{width}x@var{height}@r{[@{}+-@r{@}}@var{xoffset}@r{@{}+-@r{@}}@var{yoffset}@r{]]} | ||
| 797 | @opindex -g | ||
| 798 | Specify window size @var{width} and @var{height} (measured in character | ||
| 799 | columns and lines), and positions @var{xoffset} and @var{yoffset} | ||
| 800 | (measured in pixels). | ||
| 801 | |||
| 802 | @item --geometry=@var{width}x@var{height}@r{[@{}+-@r{@}}@var{xoffset}@r{@{}+-@r{@}}@var{yoffset}@r{]]} | ||
| 803 | @opindex --geometry | ||
| 804 | This is another way of writing the same thing. | ||
| 805 | @end table | ||
| 806 | |||
| 807 | @noindent | ||
| 808 | @code{@r{@{}+-@r{@}}} means either a plus sign or a minus sign. A plus | ||
| 809 | sign before @var{xoffset} means it is the distance from the left side of | ||
| 810 | the screen; a minus sign means it counts from the right side. A plus | ||
| 811 | sign before @var{yoffset} means it is the distance from the top of the | ||
| 812 | screen, and a minus sign there indicates the distance from the bottom. | ||
| 813 | The values @var{xoffset} and @var{yoffset} may themselves be positive or | ||
| 814 | negative, but that doesn't change their meaning, only their direction. | ||
| 815 | |||
| 816 | Emacs uses the same units as @code{xterm} does to interpret the geometry. | ||
| 817 | The @var{width} and @var{height} are measured in characters, so a large font | ||
| 818 | creates a larger frame than a small font. (If you specify a proportional | ||
| 819 | font, Emacs uses its maximum bounds width as the width unit.) The | ||
| 820 | @var{xoffset} and @var{yoffset} are measured in pixels. | ||
| 821 | |||
| 822 | Since the mode line and the echo area occupy the last 2 lines of the | ||
| 823 | frame, the height of the initial text window is 2 less than the height | ||
| 824 | specified in your geometry. In non-X-toolkit versions of Emacs, the | ||
| 825 | menu bar also takes one line of the specified number. But in the X | ||
| 826 | toolkit version, the menu bar is additional and does not count against | ||
| 827 | the specified height. The tool bar, if present, is also additional. | ||
| 828 | |||
| 829 | You do not have to specify all of the fields in the geometry | ||
| 830 | specification. | ||
| 831 | |||
| 832 | If you omit both @var{xoffset} and @var{yoffset}, the window manager | ||
| 833 | decides where to put the Emacs frame, possibly by letting you place | ||
| 834 | it with the mouse. For example, @samp{164x55} specifies a window 164 | ||
| 835 | columns wide, enough for two ordinary width windows side by side, and 55 | ||
| 836 | lines tall. | ||
| 837 | |||
| 838 | The default width for Emacs is 80 characters and the default height is | ||
| 839 | 40 lines. You can omit either the width or the height or both. If | ||
| 840 | you start the geometry with an integer, Emacs interprets it as the | ||
| 841 | width. If you start with an @samp{x} followed by an integer, Emacs | ||
| 842 | interprets it as the height. Thus, @samp{81} specifies just the width; | ||
| 843 | @samp{x45} specifies just the height. | ||
| 844 | |||
| 845 | If you start with @samp{+} or @samp{-}, that introduces an offset, | ||
| 846 | which means both sizes are omitted. Thus, @samp{-3} specifies the | ||
| 847 | @var{xoffset} only. (If you give just one offset, it is always | ||
| 848 | @var{xoffset}.) @samp{+3-3} specifies both the @var{xoffset} and the | ||
| 849 | @var{yoffset}, placing the frame near the bottom left of the screen. | ||
| 850 | |||
| 851 | You can specify a default for any or all of the fields in | ||
| 852 | @file{.Xdefaults} file, and then override selected fields with a | ||
| 853 | @samp{--geometry} option. | ||
| 854 | |||
| 855 | @node Borders X | ||
| 856 | @appendixsec Internal and External Borders | ||
| 857 | @cindex borders (X Window System) | ||
| 858 | |||
| 859 | An Emacs frame has an internal border and an external border. The | ||
| 860 | internal border is an extra strip of the background color around the | ||
| 861 | text portion of the frame. Emacs itself draws the internal border. | ||
| 862 | The external border is added by the window manager outside the frame; | ||
| 863 | depending on the window manager you use, it may contain various boxes | ||
| 864 | you can click on to move or iconify the window. | ||
| 865 | |||
| 866 | @table @samp | ||
| 867 | @item -ib @var{width} | ||
| 868 | @opindex -ib | ||
| 869 | @itemx --internal-border=@var{width} | ||
| 870 | @opindex --internal-border | ||
| 871 | @cindex border width, command-line argument | ||
| 872 | Specify @var{width} as the width of the internal border, in pixels. | ||
| 873 | |||
| 874 | @item -bw @var{width} | ||
| 875 | @opindex -bw | ||
| 876 | @itemx --border-width=@var{width} | ||
| 877 | @opindex --border-width | ||
| 878 | Specify @var{width} as the width of the main border, in pixels. | ||
| 879 | @end table | ||
| 880 | |||
| 881 | When you specify the size of the frame, that does not count the | ||
| 882 | borders. The frame's position is measured from the outside edge of the | ||
| 883 | external border. | ||
| 884 | |||
| 885 | Use the @samp{-ib @var{n}} option to specify an internal border | ||
| 886 | @var{n} pixels wide. The default is 1. Use @samp{-bw @var{n}} to | ||
| 887 | specify the width of the external border (though the window manager may | ||
| 888 | not pay attention to what you specify). The default width of the | ||
| 889 | external border is 2. | ||
| 890 | |||
| 891 | @node Title X | ||
| 892 | @appendixsec Frame Titles | ||
| 893 | |||
| 894 | An Emacs frame may or may not have a specified title. The frame | ||
| 895 | title, if specified, appears in window decorations and icons as the | ||
| 896 | name of the frame. If an Emacs frame has no specified title, the | ||
| 897 | default title has the form @samp{@var{invocation-name}@@@var{machine}} | ||
| 898 | (if there is only one frame) or the selected window's buffer name (if | ||
| 899 | there is more than one frame). | ||
| 900 | |||
| 901 | You can specify a title for the initial Emacs frame with a command | ||
| 902 | line option: | ||
| 903 | |||
| 904 | @table @samp | ||
| 905 | @item -title @var{title} | ||
| 906 | @opindex --title | ||
| 907 | @itemx --title=@var{title} | ||
| 908 | @itemx -T @var{title} | ||
| 909 | @opindex -T | ||
| 910 | @cindex frame title, command-line argument | ||
| 911 | Specify @var{title} as the title for the initial Emacs frame. | ||
| 912 | @end table | ||
| 913 | |||
| 914 | The @samp{--name} option (@pxref{Resources X}) also specifies the title | ||
| 915 | for the initial Emacs frame. | ||
| 916 | |||
| 917 | @node Icons X | ||
| 918 | @appendixsec Icons | ||
| 919 | @cindex icons (X Window System) | ||
| 920 | |||
| 921 | Most window managers allow the user to ``iconify'' a frame, removing | ||
| 922 | it from sight, and leaving a small, distinctive ``icon'' window in its | ||
| 923 | place. Clicking on the icon window makes the frame itself appear again. | ||
| 924 | If you have many clients running at once, you can avoid cluttering up | ||
| 925 | the screen by iconifying most of the clients. | ||
| 926 | |||
| 927 | @table @samp | ||
| 928 | @item -i | ||
| 929 | @opindex -i | ||
| 930 | @itemx --icon-type | ||
| 931 | @opindex --icon-type | ||
| 932 | @cindex Emacs icon, a gnu | ||
| 933 | Use a picture of a gnu as the Emacs icon. | ||
| 934 | |||
| 935 | @item -iconic | ||
| 936 | @opindex --iconic | ||
| 937 | @itemx --iconic | ||
| 938 | @cindex start iconified, command-line argument | ||
| 939 | Start Emacs in iconified state. | ||
| 940 | @end table | ||
| 941 | |||
| 942 | The @samp{-i} or @samp{--icon-type} option tells Emacs to use an icon | ||
| 943 | window containing a picture of the GNU gnu. If omitted, Emacs lets the | ||
| 944 | window manager choose what sort of icon to use---usually just a small | ||
| 945 | rectangle containing the frame's title. | ||
| 946 | |||
| 947 | The @samp{-iconic} option tells Emacs to begin running as an icon, | ||
| 948 | rather than showing a frame right away. In this situation, the icon | ||
| 949 | is the only indication that Emacs has started; the text frame doesn't | ||
| 950 | appear until you deiconify it. | ||