Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

[3736ff]: src / man.c Maximize Restore History

Download this file

man.c    1397 lines (1203 with data), 34.9 kB

   1
   2
   3
   4
   5
   6
   7
   8
   9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75
  76
  77
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
/*
* man.c
*
* Copyright (c) 1990, 1991, John W. Eaton.
*
* You may distribute under the terms of the GNU General Public
* License as specified in the file COPYING that comes with the man
* distribution.
*
* John W. Eaton
* jwe@che.utexas.edu
* Department of Chemical Engineering
* The University of Texas at Austin
* Austin, Texas 78712
*
* Some manpath, compression and locale related changes - aeb - 940320
* Some suid related changes - aeb - 941008
* Some more fixes, Pauline Middelink & aeb, Oct 1994
* man -K: aeb, Jul 1995
* Split off of manfile for man2html, aeb, New Year's Eve 1997
* Portability enhancements - kdm, June 2005
* Remove `do_win32' rubbish - kdm, March 2008
*/
#include "compat.h"
#include <stdio.h>
#include <ctype.h>
#if defined(HAVE_STRING_H)
#include <string.h>
#elif defined(HAVE_STRINGS_H)
#include <strings.h>
#endif
#ifdef HAVE_STDLIB_H
#include <stdlib.h>
#endif
#ifdef HAVE_SYS_FILE_H
#include <sys/file.h>
#endif
#ifdef HAVE_SYS_STAT_H
#include <sys/stat.h> /* for chmod */
#endif
#include <signal.h>
#include <errno.h>
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#ifdef HAVE_LOCALE_H
#include <locale.h>
#endif
#ifdef HAVE_SYS_TERMIOS_H
#include <sys/termios.h>
#endif
#ifndef R_OK
#define R_OK 4
#endif
/* if we don't have the strchr() and strrchr() functions,
* then we must fall back to index() and rindex() respectively,
* but (apparently) these aren't always prototyped in string.h
*/
#ifndef index
/* i.e. NOT using strchr()
*/
extern char *index (const char *, int);
#endif
#ifndef rindex
/* i.e. NOT using strrchr()
*/
extern char *rindex (const char *, int);
#endif
#include "defs.h"
#include "gripes.h"
#include "man.h"
#include "manfile.h"
#include "manpath.h"
#include "man-config.h"
#include "man-getopt.h"
#include "man-iconv.h"
#include "to_cat.h"
#include "util.h"
#include "glob.h"
#include "different.h"
#include "man-iconv.h"
#define SIZE(x) (sizeof(x)/sizeof((x)[0]))
const char *progname;
const char *pager, *browser, *htmlpager;
char *colon_sep_section_list;
char *roff_directive;
char *dohp = 0;
int do_irix;
int apropos;
int whatis;
int nocats; /* set by -c option: do not use cat page */
/* this means that cat pages must not be used,
perhaps because the user knows they are
old or corrupt or so */
int can_use_cache; /* output device is a tty, width 80 */
/* this means that the result may be written
in /var/cache, and may be read from there */
int findall;
int print_where;
int one_per_line;
int do_troff;
int preformat;
int debug;
int fhs;
int fsstnd;
int noautopath;
int nocache;
static int is_japanese;
static char *language;
static char **section_list;
#ifdef DO_COMPRESS
int do_compress = 1;
#else
int do_compress = 0;
#endif
#define BUFSIZE 8192
/*
* Try to determine the line length to use.
* Preferences: 1. MANWIDTH, 2. ioctl, 3. COLUMNS, 4. 80
*
* joey, 950902
*/
#ifdef HAVE_SYS_IOCTL_H
# include <sys/ioctl.h>
#endif
int line_length = 80;
int ll = 0;
static void
get_line_length(void){
char *cp;
int width;
if (preformat) {
line_length = 80;
return;
}
if ((cp = getenv ("MANWIDTH")) != NULL && (width = atoi(cp)) > 0) {
line_length = width;
return;
}
#ifdef TIOCGWINSZ
if (isatty(0) && isatty(1)) { /* Jon Tombs */
struct winsize wsz;
if(ioctl(0, TIOCGWINSZ, &wsz))
perror("TIOCGWINSZ failed\n");
else if(wsz.ws_col) {
line_length = wsz.ws_col;
return;
}
}
#endif
if ((cp = getenv ("COLUMNS")) != NULL && (width = atoi(cp)) > 0)
line_length = width;
else
line_length = 80;
}
static int
setll(void) {
return
(!do_troff && (line_length < 66 || line_length > 80)) ?
line_length*9/10 : 0;
}
/* People prefer no page headings in their man screen output;
now ".pl 0" has a bad effect on .SH etc, so we need ".pl N"
for some large number N, like 1100i (a hundred pages). */
#define VERY_LONG_PAGE "1100i"
static char *
setpl(void) {
char *pl;
if (do_troff)
return NULL;
if (preformat)
pl = VERY_LONG_PAGE;
else
if ((pl = getenv("MANPL")) == 0) {
if (isatty(0) && isatty(1))
pl = VERY_LONG_PAGE;
else
pl = "11i"; /* old troff default */
}
return pl;
}
/*
* Check to see if the argument is a valid section number. If the
* first character of name is a numeral, or the name matches one of
* the sections listed in section_list, we'll assume that it's a section.
* The list of sections in config.h simply allows us to specify oddly
* named directories like .../man3f. Yuk.
*/
static char *
is_section (char *name) {
char **vs;
/* 3Xt may be a section, but 3DBorder is a man page */
if (isdigit (name[0]) && !isdigit (name[1]) && strlen(name) < 5)
return my_strdup (name);
for (vs = section_list; *vs != NULL; vs++)
if (strcmp (*vs, name) == 0)
return my_strdup (name);
return NULL;
}
static void
remove_file (char *file) {
int i;
i = unlink (file);
if (debug) {
if (i)
perror(file);
else
gripe (UNLINKED, file);
}
}
static void
remove_other_catfiles (const char *catfile) {
char *pathname;
char *t;
char **gf;
int offset;
pathname = my_strdup(catfile);
t = rindex(pathname, '.');
if (t == NULL || strcmp(t, getval("COMPRESS_EXT")))
return;
offset = t - pathname;
strcpy(t, "*");
gf = glob_filename (pathname);
if (gf != (char **) -1 && gf != NULL) {
for ( ; *gf; gf++) {
/*
* Only remove files with a known extension, like .Z
* (otherwise we might kill a lot when called with
* catfile = ".gz" ...)
*/
if (strlen (*gf) <= offset) {
if (strlen (*gf) == offset) /* uncompressed version */
remove_file (*gf);
continue;
}
if (!strcmp (*gf + offset, getval("COMPRESS_EXT")))
continue;
if (get_expander (*gf) != NULL)
remove_file (*gf);
}
}
}
/*
* Simply display the preformatted page.
*/
static int
display_cat_file (const char *file) {
int found;
if (preformat)
return 1; /* nothing to do - preformat only */
found = 0;
if (access (file, R_OK) == 0 && different_cat_file(file)) {
char *command = NULL;
const char *expander = get_expander (file);
if (expander != NULL && expander[0] != 0) {
if (isatty(1))
command = my_xsprintf("%s %S | %s", expander, file, pager);
else
command = my_xsprintf("%s %S", expander, file);
} else {
if (isatty(1)) {
command = my_xsprintf("%s %S", pager, file);
} else {
const char *cat = getval("CAT");
command = my_xsprintf("%s %S", cat[0] ? cat : "cat", file);
}
}
found = !do_system_command (command, 0);
}
return found;
}
/*
* Simply display the preformatted page.
*/
static int
display_html_file (const char *file) {
int found;
found = 0;
if (access (file, R_OK) == 0 && different_cat_file(file)) {
char *command = NULL;
if (isatty(1)) {
command = my_xsprintf("%s %S", browser, file);
} else {
command = my_xsprintf("%s %S", htmlpager, file);
}
found = !do_system_command (command, 0);
}
return found;
return 1;
}
/*
* Try to find the ultimate source file. If the first line of the
* current file is not of the form
*
* .so man3/printf.3s
*
* the input file name is returned.
*
* For /cd/usr/src/usr.bin/util-linux-1.5/mount/umount.8.gz
* (which contains `.so man8/mount.8')
* we return /cd/usr/src/usr.bin/util-linux-1.5/mount/mount.8.gz .
*
* For /usr/man/man3/TIFFScanlineSize.3t
* (which contains `.so TIFFsize.3t')
* we return /usr/man/man3/TIFFsize.3t .
*/
static const char *
ultimate_source (const char *name0) {
FILE *fp;
char *name;
const char *expander;
int expfl = 0;
char *fgr;
char *beg;
char *end;
char *cp;
char buf[BUFSIZE];
static char ultname[BUFSIZE];
if (strlen(name0) >= sizeof(ultname))
return name0;
strcpy(ultname, name0);
name = ultname;
again:
expander = get_expander (name);
if (expander && *expander) {
char *command;
command = my_xsprintf ("%s %S", expander, name);
fp = my_popen (command, "r");
if (fp == NULL) {
perror("popen");
gripe (EXPANSION_FAILED, command);
return (NULL);
}
fgr = fgets (buf, sizeof(buf), fp);
pclose (fp);
expfl = 1;
} else {
fp = fopen (name, "r");
if (fp == NULL && expfl) {
char *extp = rindex (name0, '.');
if (extp && *extp && strlen(name)+strlen(extp) < BUFSIZE) {
strcat(name, extp);
fp = fopen (name, "r");
}
}
/*
* Some people have compressed man pages, but uncompressed
* .so files - we could glob for all possible extensions,
* for now: only try .gz
*/
else if (fp == NULL && get_expander(".gz") &&
strlen(name)+strlen(".gz") < BUFSIZE) {
strcat(name, ".gz");
fp = fopen (name, "r");
}
if (fp == NULL) {
perror("fopen");
gripe (OPEN_ERROR, name);
return (NULL);
}
fgr = fgets (buf, sizeof(buf), fp);
fclose (fp);
}
if (fgr == NULL) {
perror("fgets");
gripe (READ_ERROR, name);
return (NULL);
}
if (strncmp(buf, ".so", 3))
return (my_strdup(name));
beg = buf+3;
while (*beg == ' ' || *beg == '\t')
beg++;
end = beg;
while (*end != ' ' && *end != '\t' && *end != '\n' && *end != '\0')
end++; /* note that buf is NUL-terminated */
*end = '\0';
/* If name ends in path/manx/foo.9x then use path, otherwise
try same directory. */
if ((cp = rindex(name, '/')) == NULL) /* very strange ... */
return 0;
*cp = 0;
/* allow "man ./foo.3" where foo.3 contains ".so man2/bar.2" */
if ((cp = rindex(name, '/')) != NULL && !strcmp(cp+1, "."))
*cp = 0;
/* In all cases, the new name will be something from name
followed by something from beg. */
if (strlen(name) + strlen(beg) + 1 >= BUFSIZ)
return 0; /* very long names, ignore */
if (!index(beg, '/')) {
/* strange.. try same directory as the .so file */
strcat(name, "/");
strcat(name, beg);
} else if((cp = rindex(name, '/')) != NULL && !strncmp(cp+1, "man", 3)) {
strcpy(cp+1, beg);
} else if((cp = rindex(beg, '/')) != NULL) {
strcat(name, cp);
} else {
strcat(name, "/");
strcat(name, beg);
}
goto again;
}
static void
add_directive (const char *d, const char *file, char *buf, int buflen) {
if ((d = getval(d)) != 0 && *d) {
if (*buf == 0) {
if (strlen(d) + strlen(file) + 2 > buflen)
return;
strcpy (buf, d);
strcat (buf, " ");
strcat (buf, file);
} else {
if (strlen(d) + strlen(buf) + 4 > buflen)
return;
strcat (buf, " | ");
strcat (buf, d);
}
}
}
static int
is_lang_page (char *lang, const char *file) {
char lang_path[16] = "";
snprintf(lang_path, sizeof(lang_path), "/%s/", lang);
if (strstr(file, lang_path))
return 1;
if (strlen(lang) > 2) {
lang_path[3] = '/';
lang_path[4] = 0;
if (strstr(file, lang_path))
return 1;
}
return 0;
}
static int
parse_roff_directive (char *cp, const char *file, char *buf, int buflen) {
char c;
int tbl_found = 0;
int use_jroff;
use_jroff = (is_japanese &&
(strstr(file, "/jman/") || is_lang_page(language, file)));
while ((c = *cp++) != '\0') {
switch (c) {
case 'e':
if (debug)
gripe (FOUND_EQN);
add_directive((do_troff ? "EQN" : use_jroff ? "JNEQN": "NEQN"),
file, buf, buflen);
break;
case 'g':
if (debug)
gripe (FOUND_GRAP);
add_directive ("GRAP", file, buf, buflen);
break;
case 'p':
if (debug)
gripe (FOUND_PIC);
add_directive ("PIC", file, buf, buflen);
break;
case 't':
if (debug)
gripe (FOUND_TBL);
tbl_found++;
add_directive ("TBL", file, buf, buflen);
break;
case 'v':
if (debug)
gripe (FOUND_VGRIND);
add_directive ("VGRIND", file, buf, buflen);
break;
case 'r':
if (debug)
gripe (FOUND_REFER);
add_directive ("REFER", file, buf, buflen);
break;
case ' ':
case '\t':
case '\n':
goto done;
default:
return -1;
}
}
done:
if (*buf == 0)
return 1;
add_directive (do_troff ? "TROFF" : use_jroff ? "JNROFF" : "NROFF",
"", buf, buflen);
if (tbl_found && !do_troff && *getval("COL"))
add_directive ("COL", "", buf, buflen);
return 0;
}
static char *
eos(char *s) {
while(*s) s++;
return s;
}
/*
* Create command to format FILE, in the directory PATH/manX
*/
static char *
make_roff_command (const char *path, const char *file) {
FILE *fp;
static char buf [BUFSIZE];
char line [BUFSIZE], bufh [BUFSIZE], buft [BUFSIZE];
int status, ll;
char *cp, *fgr, *pl;
char *command = "";
const char *expander;
const char *converter;
/* if window size differs much from 80, try to adapt */
/* (but write only standard formatted files to the cat directory,
see can_use_cache) */
ll = setll();
pl = setpl();
if (ll && debug)
gripe (NO_CAT_FOR_NONSTD_LL);
expander = get_expander (file);
converter = get_converter (path);
/* head */
bufh[0] = 0;
if (ll || pl) {
/* some versions of echo do not accept the -e flag,
so we just use two echo calls when needed */
strcat(bufh, "(");
if (ll) {
/*
* We should set line length and title line length.
* However, a .lt command here fails, only
* .ev 1; .lt ...; .ev helps for my version of groff.
* (The LL assignment is needed by the mandoc macros
* provided with groff versions 1.18 through 1.19.1;
* neither earlier nor later versions require this,
* but we keep it to support those versions).
*/
sprintf(eos(bufh), "echo \".ll %d.%di\"; ", ll/10, ll%10);
sprintf(eos(bufh), "echo \".nr LL %d.%di\"; ", ll/10, ll%10);
#if 0
sprintf(eos(bufh), "echo \".lt %d.%di\"; ", ll/10, ll%10);
#endif
}
if (pl)
sprintf(eos(bufh), "echo \".pl %.128s\"; ", pl);
}
/* tail */
buft[0] = 0;
if (ll || pl) {
if (pl && !strcmp(pl, VERY_LONG_PAGE))
/* At end of the nroff source, set the page length to
the current position plus 10 lines. This plus setpl()
gives us a single page that just contains the whole
man page. (William Webber, wew@cs.rmit.edu.au) */
strcat(buft, "; echo \".\\\\\\\"\"; echo \".pl \\n(nlu+10\"");
#if 0
/* In case this doesnt work for some reason,
michaelkjohnson suggests: I've got a simple
awk invocation that I throw into the pipeline: */
awk 'BEGIN {RS="\n\n\n\n*"} /.*/ {print}'
#endif
strcat(buft, ")");
}
if (expander && *expander) {
if (converter && *converter)
command = my_xsprintf("%s%s '%S' | %s%s",
bufh, expander, file, converter, buft);
else
command = my_xsprintf("%s%s '%S'%s",
bufh, expander, file, buft);
} else if (ll || pl) {
const char *cat = getval("CAT");
if (!cat || !*cat)
cat = "cat";
if (converter && *converter)
command = my_xsprintf("%s%s '%S' | %s%s",
bufh, cat, file, converter, buft);
else
command = my_xsprintf("%s%s '%S'%s",
bufh, cat, file, buft);
}
if (strlen(command) >= sizeof(buf))
exit(1);
strcpy(buf, command);
if (roff_directive != NULL) {
if (debug)
gripe (ROFF_FROM_COMMAND_LINE);
status = parse_roff_directive (roff_directive, file,
buf, sizeof(buf));
if (status == 0)
return buf;
if (status == -1)
gripe (ROFF_CMD_FROM_COMMANDLINE_ERROR);
}
if (expander && *expander) {
char *cmd = my_xsprintf ("%s %S", expander, file);
fp = my_popen (cmd, "r");
if (fp == NULL) {
perror("popen");
gripe (EXPANSION_FAILED, cmd);
return (NULL);
}
fgr = fgets (line, sizeof(line), fp);
pclose (fp);
} else {
fp = fopen (file, "r");
if (fp == NULL) {
perror("fopen");
gripe (OPEN_ERROR, file);
return (NULL);
}
fgr = fgets (line, sizeof(line), fp);
fclose (fp);
}
if (fgr == NULL) {
perror("fgets");
gripe (READ_ERROR, file);
return (NULL);
}
cp = &line[0];
if (*cp++ == '\'' && *cp++ == '\\' && *cp++ == '"' && *cp++ == ' ') {
if (debug)
gripe (ROFF_FROM_FILE, file);
status = parse_roff_directive (cp, file, buf, sizeof(buf));
if (status == 0)
return buf;
if (status == -1)
gripe (ROFF_CMD_FROM_FILE_ERROR, file);
}
if ((cp = getenv ("MANROFFSEQ")) != NULL) {
if (debug)
gripe (ROFF_FROM_ENV);
status = parse_roff_directive (cp, file, buf, sizeof(buf));
if (status == 0)
return buf;
if (status == -1)
gripe (MANROFFSEQ_ERROR);
}
if (debug)
gripe (USING_DEFAULT);
(void) parse_roff_directive ("t", file, buf, sizeof(buf));
return buf;
}
/*
* Try to format the man page and create a new formatted file. Return
* 1 for success and 0 for failure.
*/
static int
make_cat_file (const char *path, const char *man_file, const char *cat_file) {
int mode;
FILE *fp;
char *roff_command;
char *command = NULL;
struct stat statbuf;
/* _Before_ first, make sure we will write to a regular file. */
if (stat(cat_file, &statbuf) == 0) {
if(!S_ISREG(statbuf.st_mode)) {
if (debug)
gripe (CAT_OPEN_ERROR, cat_file);
return 0;
}
}
/* First make sure we can write the file; create an empty file. */
/* If we are suid it must get mode 0666. */
if ((fp = fopen (cat_file, "w")) == NULL) {
if (errno == ENOENT) /* directory does not exist */
return 0;
/* If we cannot write the file, maybe we can delete it */
if(unlink (cat_file) != 0 || (fp = fopen (cat_file, "w")) == NULL) {
if (errno == EROFS) /* possibly a CDROM */
return 0;
if (debug)
gripe (CAT_OPEN_ERROR, cat_file);
if (!suid)
return 0;
/* maybe the real user can write it */
/* note: just doing "> %s" gives the wrong exit status */
command = my_xsprintf("cp /dev/null %S 2>/dev/null", cat_file);
if (do_system_command(command, 1)) {
if (debug)
gripe (USER_CANNOT_OPEN_CAT);
return 0;
}
if (debug)
gripe (USER_CAN_OPEN_CAT);
}
} else {
/* we can write it - good */
fclose (fp);
/* but maybe the real user cannot - let's allow everybody */
/* the mode is reset below */
if (suid) {
if (chmod (cat_file, 0666)) {
/* probably we are sgid but not owner;
just delete the file and create it again */
if(unlink(cat_file) != 0) {
command = my_xsprintf("rm %S", cat_file);
(void) do_system_command (command, 1);
}
if ((fp = fopen (cat_file, "w")) != NULL)
fclose (fp);
}
}
}
roff_command = make_roff_command (path, man_file);
if (roff_command == NULL)
return 0;
if (do_compress)
/* The cd is necessary, because of .so commands,
like .so man1/bash.1 in bash_builtins.1.
But it changes the meaning of man_file and cat_file,
if these are not absolute. */
command = my_xsprintf("(cd %S && %s | %S > %S)", path,
roff_command, getval("COMPRESS"), cat_file);
else
command = my_xsprintf ("(cd %S && %s > %S)", path,
roff_command, cat_file);
/*
* Don't let the user interrupt the system () call and screw up
* the formatted man page if we're not done yet.
*/
signal (SIGINT, SIG_IGN);
gripe (PLEASE_WAIT);
if (!do_system_command (command, 0)) {
/* success */
mode = ((ruid != euid) ? 0644 : (rgid != egid) ? 0464 : 0444);
if(chmod (cat_file, mode) != 0 && suid) {
command = my_xsprintf ("chmod 0%o %S", mode, cat_file);
(void) do_system_command (command, 1);
}
/* be silent about the success of chmod - it is not important */
if (debug)
gripe (CHANGED_MODE, cat_file, mode);
} else {
/* something went wrong - remove garbage */
if(unlink(cat_file) != 0 && suid) {
command = my_xsprintf ("rm %S", cat_file);
(void) do_system_command (command, 1);
}
}
signal (SIGINT, SIG_DFL);
return 1;
}
static int
display_man_file(const char *path, const char *man_file) {
char *roff_command;
char *command;
if (!different_man_file (man_file))
return 0;
roff_command = make_roff_command (path, man_file);
if (roff_command == NULL)
return 0;
if (do_troff)
command = my_xsprintf ("(cd %S && %s)", path, roff_command);
else
command = my_xsprintf ("(cd %S && %s | %s)", path,
roff_command, pager);
return !do_system_command (command, 0);
}
/*
* make and display the cat file - return 0 if something went wrong
*/
static int
make_and_display_cat_file (const char *path, const char *man_file) {
const char *cat_file;
const char *ext;
int status;
int standards;
ext = (do_compress ? getval("COMPRESS_EXT") : 0);
standards = (fhs ? FHS : 0) | (fsstnd ? FSSTND : 0) | (dohp ? DO_HP : 0);
if ((cat_file = convert_to_cat(man_file, ext, standards)) == NULL)
return 0;
if (debug)
gripe (PROPOSED_CATFILE, cat_file);
/*
* If cat_file exists, check whether it is more recent.
* Otherwise, check for other cat files (maybe there are
* old .Z files that should be removed).
*/
status = ((nocats | preformat) ? -2 : is_newer (man_file, cat_file));
if (debug)
gripe (IS_NEWER_RESULT, status);
if (status == -1 || status == -3) {
/* what? man_file does not exist anymore? */
gripe (CANNOT_STAT, man_file);
return(0);
}
if (status != 0 || access (cat_file, R_OK) != 0) {
/*
* Cat file is out of date (status = 1) or does not exist or is
* empty or is to be rewritten (status = -2) or is unreadable.
* Try to format and save it.
*/
if (print_where) {
printf ("%s\n", man_file);
return 1;
}
if (!make_cat_file (path, man_file, cat_file))
return 0;
/*
* If we just created this cat file, unlink any others.
*/
if (status == -2 && do_compress)
remove_other_catfiles(cat_file);
} else {
/*
* Formatting not necessary. Cat file is newer than source
* file, or source file is not present but cat file is.
*/
if (print_where) {
if (one_per_line) {
/* addition by marty leisner - leisner@sdsp.mc.xerox.com */
printf("%s\n", cat_file);
printf("%s\n", man_file);
} else
printf ("%s (<-- %s)\n", cat_file, man_file);
return 1;
}
}
(void) display_cat_file (cat_file);
return 1;
}
/*
* Try to format the man page source and save it, then display it. If
* that's not possible, try to format the man page source and display
* it directly.
*/
static int
format_and_display (const char *man_file) {
const char *path;
if (access (man_file, R_OK) != 0)
return 0;
path = mandir_of(man_file);
if (path == NULL)
return 0;
/* first test for contents .so man1/xyzzy.1 */
/* (in that case we do not want to make a cat file identical
to cat1/xyzzy.1) */
man_file = ultimate_source (man_file);
if (man_file == NULL)
return 0;
if (do_troff) {
char *command;
char *roff_command = make_roff_command (path, man_file);
if (roff_command == NULL)
return 0;
command = my_xsprintf("(cd %S && %s)", path, roff_command);
return !do_system_command (command, 0);
}
if (can_use_cache && make_and_display_cat_file (path, man_file))
return 1;
/* line length was wrong or could not display cat_file */
if (print_where) {
printf ("%s\n", man_file);
return 1;
}
return display_man_file (path, man_file);
}
/*
* Search for manual pages.
*
* If preformatted manual pages are supported, look for the formatted
* file first, then the man page source file. If they both exist and
* the man page source file is newer, or only the source file exists,
* try to reformat it and write the results in the cat directory. If
* it is not possible to write the cat file, simply format and display
* the man file.
*
* If preformatted pages are not supported, or the troff option is
* being used, only look for the man page source file.
*
* Note that globbing is necessary also if the section is given,
* since a preformatted man page might be compressed.
*
*/
static int
man (const char *name, const char *section) {
int found, type, flags;
struct manpage *mp;
found = 0;
/* allow man ./manpage for formatting explicitly given man pages */
if (index(name, '/')) {
char fullname[BUFSIZE];
char fullpath[BUFSIZE];
char *path;
char *cp;
FILE *fp = fopen(name, "r");
if (!fp) {
perror(name);
return 0;
}
fclose (fp);
if ( ! IS_ABSOLUTE_PATH(name)
&& getcwd(fullname, sizeof(fullname))
&& strlen(fullname) + strlen(name) + 3 < sizeof(fullname)) {
strcat (fullname, "/");
strcat (fullname, name);
} else if (strlen(name) + 2 < sizeof(fullname)) {
strcpy (fullname, name);
} else {
fprintf(stderr, "%s: name too long\n", name);
return 0;
}
strcpy (fullpath, POSIX_STYLE_PATH(fullname));
if ((cp = rindex(fullpath, '/')) != NULL
&& cp-fullpath+4 < sizeof(fullpath)) {
strcpy(cp+1, "..");
path = fullpath;
} else
path = ".";
name = ultimate_source (fullname);
if (!name)
return 0;
if (print_where) {
printf("%s\n", name);
return 1;
}
return display_man_file (path, name);
}
fflush (stdout);
init_manpath();
can_use_cache = nocache ? 0 : (preformat || print_where ||
(isatty(0) && isatty(1) && !setll()));
if (do_troff) {
const char *t = getval("TROFF");
if (!t || !*t)
return 0; /* don't know how to format */
type = TYPE_MAN;
} else {
const char *n = getval("NROFF");
type = 0;
if (can_use_cache)
type |= TYPE_CAT;
if (n && *n)
type |= TYPE_MAN;
if (fhs || fsstnd)
type |= TYPE_SCAT;
n = getval("BROWSER");
if (n && *n)
type |= TYPE_HTML;
}
flags = type;
if (!findall)
flags |= ONLY_ONE;
if (fsstnd)
flags |= FSSTND;
else if (fhs)
flags |= FHS;
if (dohp)
flags |= DO_HP;
if (do_irix)
flags |= DO_IRIX;
mp = manfile(name, section, flags, section_list, mandirlist,
convert_to_cat);
found = 0;
while (mp) {
if (mp->type == TYPE_MAN) {
found = format_and_display(mp->filename);
} else if (mp->type == TYPE_CAT || mp->type == TYPE_SCAT) {
if (print_where) {
printf ("%s\n", mp->filename);
found = 1;
} else
found = display_cat_file(mp->filename);
} else if (mp->type == TYPE_HTML) {
if (print_where) {
printf ("%s\n", mp->filename);
found = 1;
} else
found = display_html_file(mp->filename);
} else
/* internal error */
break;
if (found && !findall)
break;
mp = mp->next;
}
return found;
}
static char **
get_section_list (void) {
int i;
const char *p;
char *end;
static char *tmp_section_list[100];
if (colon_sep_section_list == NULL) {
if ((p = getenv ("MANSECT")) == NULL)
p = getval ("MANSECT");
colon_sep_section_list = my_strdup (p);
}
i = 0;
for (p = colon_sep_section_list; ; p = end+1) {
if ((end = strchr (p, ':')) != NULL)
*end = '\0';
tmp_section_list[i++] = my_strdup (p);
if (end == NULL || i+1 == SIZE(tmp_section_list))
break;
}
tmp_section_list [i] = NULL;
return tmp_section_list;
}
/* return 0 when all was OK */
static int
do_global_apropos (char *name, char *section) {
char **dp, **gf;
char *pathname;
char *command;
int status, res;
status = 0;
init_manpath();
if (mandirlist)
for (dp = mandirlist; *dp; dp++) {
if (debug)
gripe(SEARCHING, *dp);
pathname = my_xsprintf("%s/man%s/*", *dp, section ? section : "*");
gf = glob_filename (pathname);
free(pathname);
if (gf != (char **) -1 && gf != NULL) {
for( ; *gf; gf++) {
const char *expander = get_expander (*gf);
if (expander)
command = my_xsprintf("%s %S | grep %s '%Q'",
expander, *gf, GREPSILENT, name);
else
command = my_xsprintf("grep %s '%Q' %S",
GREPSILENT, name, *gf);
res = do_system_command (command, 1);
status |= res;
free (command);
if (res == 0) {
if (print_where)
printf("%s\n", *gf);
else {
/* should read LOCALE, but libc 4.6.27 doesn't
seem to handle LC_RESPONSE yet */
int answer, c;
char path[BUFSIZE];
printf("%s? [ynq] ", *gf);
fflush(stdout);
answer = c = getchar();
while (c != '\n' && c != EOF)
c = getchar();
if(index("QqXx", answer))
exit(0);
if(index("YyJj", answer)) {
char *ri;
strcpy(path, *gf);
ri = rindex(path, '/');
if (ri)
*ri = 0;
format_and_display(*gf);
}
}
}
}
}
}
return status;
}
/* Special code for Japanese (to pick jnroff instead of nroff, etc.) */
static void
setlang(void) {
char *lang;
/* We use getenv() instead of setlocale(), because of
glibc 2.1.x security policy for SetUID/SetGID binary. */
if ((lang = getenv("LANG")) == NULL &&
(lang = getenv("LC_ALL")) == NULL &&
(lang = getenv("LC_CTYPE")) == NULL)
/* nothing */;
language = lang;
is_japanese = (lang && strncmp(lang, "ja", 2) == 0);
}
/*
* Handle the apropos option. Cheat by using another program.
*/
static int
do_apropos (char *name) {
char *command;
command = my_xsprintf("'%s' '%Q'", getval("APROPOS"), name);
return do_system_command (command, 0);
}
/*
* Handle the whatis option. Cheat by using another program.
*/
static int
do_whatis (char *name) {
char *command;
command = my_xsprintf("'%s' '%Q'", getval("WHATIS"), name);
return do_system_command (command, 0);
}
int
main (int argc, char **argv) {
int status = 0;
char *nextarg;
char *tmp;
char *section = 0;
#ifdef __CYGWIN__
extern int optind;
#endif
#if 0
{
/* There are no known cases of buffer overflow caused by
excessively long environment variables. In case you find one,
the simplistic way to fix is to enable this stopgap. */
char *s;
#define CHECK(p,l) s=getenv(p); if(s && strlen(s)>(l)) { fprintf(stderr, "ERROR: Environment variable %s too long!\n", p); exit(1); }
CHECK("LANG", 32);
CHECK("LANGUAGE", 128);
CHECK("LC_MESSAGES", 128);
CHECK("MANPAGER", 128);
CHECK("MANPL", 128);
CHECK("MANROFFSEQ", 128);
CHECK("MANSECT", 128);
CHECK("MAN_HP_DIREXT", 128);
CHECK("PAGER", 128);
CHECK("SYSTEM", 64);
CHECK("BROWSER", 64);
CHECK("HTMLPAGER", 64);
/* COLUMNS, LC_ALL, LC_CTYPE, MANPATH, MANWIDTH, MAN_IRIX_CATNAMES,
MAN_ICONV_PATH, MAN_ICONV_OPT, MAN_ICONV_INPUT_CHARSET,
MAN_ICONV_OUTPUT_CHARSET, NLSPATH, PATH */
}
#endif
/* For internationalisation, we expect to be able to identify an
* ISO-639 two character language code from the LC_ALL, LC_MESSAGES
* or, (as a final fallback), from the LANG environment variables,
* or failing that, from a call to `setlocale'. On Win32, typically,
* NONE of these variables will be set, and the native `setlocale'
* implementation doesn't give us the ISO-639 format we require;
* to work around this, the following macro, defined in compat.h,
* uses an alternative Win32 API to get the ISO-639 code for the
* user's default locale, saving it in the LANG environment variable,
* for us to use later; (the user may override this, by explicitly
* setting LANG first). On platforms other than Win32, (and even
* on Win32 with Cygwin emulation of POSIX), this macro normally
* does nothing, (but see compat.h for possible exceptions).
*/
set_iso639_default("LANG");
/* #ifndef __FreeBSD__ */
/* Slaven Rezif: FreeBSD-2.2-SNAP does not recognize LC_MESSAGES. */
/* Keith Marshall: neither does MinGW, but why be platform specific?
* Don't setlocale for either of LC_CTYPE or LC_MESSAGES,
* unless they are defined
*/
#ifdef LC_CTYPE
setlocale(LC_CTYPE, ""); /* used anywhere? maybe only isdigit()? */
#endif
#ifdef LC_MESSAGES
setlocale(LC_MESSAGES, "");
#endif
/* No doubt we'll need some generic language code here later.
For the moment only Japanese support. */
setlang();
/* Handle /usr/man/man1.Z/name.1 nonsense from HP */
dohp = getenv("MAN_HP_DIREXT"); /* .Z */
/* Handle ls.z (instead of ls.1.z) cat page naming from IRIX */
if (getenv("MAN_IRIX_CATNAMES"))
do_irix = 1;
progname = mkprogname (argv[0]);
get_permissions ();
get_line_length();
/*
* read command line options and man.conf
*/
man_getopt (argc, argv);
/*
* manpath or man --path or man -w will only print the manpath
*/
if (!strcmp (progname, "manpath") || (optind == argc && print_where)) {
init_manpath();
prmanpath();
exit(0);
}
if (optind == argc)
gripe(NO_NAME_NO_SECTION);
section_list = get_section_list ();
while (optind < argc) {
nextarg = POSIX_STYLE_PATH(argv[optind++]);
/* is_section correctly accepts 3Xt as section, but also 9wm,
so we should not believe is_section() for the last arg. */
tmp = is_section (nextarg);
if (tmp && optind < argc) {
section = tmp;
if (debug)
gripe (SECTION, section);
continue;
}
if (global_apropos)
status = !do_global_apropos (nextarg, section);
else if (apropos)
status = !do_apropos (nextarg);
else if (whatis)
status = !do_whatis (nextarg);
else {
status = man (nextarg, section);
if (status == 0) {
if (section)
gripe (NO_SUCH_ENTRY_IN_SECTION, nextarg, section);
else
gripe (NO_SUCH_ENTRY, nextarg);
}
}
}
return status ? EXIT_SUCCESS : EXIT_FAILURE;
}